ody_migr_mmth_endpoint.MammothMigration Class Reference

Public Member Functions
def	__init__ (self, _cu, _data_category, _server, _username, _password, **kwargs)
def	run (self)
def	__str__ (self)

Public Attributes
	cu
	data_category
	server
	username
	password
	payload
	getstream
	histstatus
	endpoint_script
	response

Private Member Functions
def	_dest_url (self)
def	_validate_response (self)
def	_initiate_http_request (self)

Detailed Description

Retrieve response from Mammoth.

Definition at line 21 of file ody_migr_mmth_endpoint.py.

Member Function Documentation

_dest_url()

def ody_migr_mmth_endpoint.MammothMigration._dest_url (   self )

private

Generate a Mammoth endpoint url

Definition at line 71 of file ody_migr_mmth_endpoint.py.

    def _dest_url(self):
        """Generate a Mammoth endpoint url"""
        hash = generate_hash(self.data_category, self.cu,
                             os.environ.get(ENV_MIGR_SECRET_KEY))
        server_dest = "https://{}.homecu.net".format(self.server)
        if self.data_category == DATA_OPT_GETCULIST:
            resource_dest = ("{}?"
                             "passphrase={}&"
                             "action={}").format(self.endpoint_script,
                                                 hash,
                                                 self.data_category)

        else:
            resource_dest = ("{}?"
                             "cu={}&"
                             "passphrase={}&"
                             "action={}").format(self.endpoint_script,
                                                 self.cu,
                                                 hash,
                                                 self.data_category)
        return os.path.join(server_dest, resource_dest)

_initiate_http_request()

def ody_migr_mmth_endpoint.MammothMigration._initiate_http_request (   self )

private

Establish connection with Mammoth and obtain response object

Definition at line 156 of file ody_migr_mmth_endpoint.py.

    def _initiate_http_request(self):
        """Establish connection with Mammoth and obtain response object"""

        try:
            # we run http connection within the requests context manager
            # in order to avoid possible resource leaks
            with requests.Session() as s:
                url = self._dest_url()
                if self.payload is None:
                    http_resp = s.get(
                        url,
                        auth=(self.username, self.password),
                        stream=self.getstream
                    )
                else:
                    http_resp = s.post(
                        url,
                        auth=(self.username, self.password),
                        data=self.payload
                    )

                status_code = http_resp.status_code
                if int(status_code) >= 300:
                    http_resp.raise_for_status()

                LOGGER.info("HTTP response url: {}".format(http_resp.url))
                if int(status_code) == 200:
                    if self.data_category == DATA_OPT_GET_HIST:
                        self.response = http_resp

                    else:
                        self.response = http_resp.json()

        except (requests.exceptions.HTTPError,
                requests.exceptions.ConnectionError) as err:
            LOGGER.error("Mammoth endpoint status: {}".format(err))
            raise SystemExit(err)

_validate_response()

def ody_migr_mmth_endpoint.MammothMigration._validate_response (   self )

private

Validate response data returned from Mammoth.

Raises:
     SystemExit on error

Definition at line 93 of file ody_migr_mmth_endpoint.py.

    def _validate_response(self):
        """Validate response data returned from Mammoth.

        Raises:
             SystemExit on error
        """

        # at this point, response dict must have already been populated
        error_flag = False
        resp_error = DEFAULT_ERROR_STR

        if self.data_category == DATA_OPT_GET_HIST:
            # check for error in application/json response
            if dict(self.response.headers)[
                    "Content-Type"].strip() == "application/json":
                resp_error = self.response.json()["error"]
                if resp_error != DEFAULT_ERROR_STR:
                    if "Process is already started" in resp_error:
                        # do not consider this case as error
                        if "ERROR:" in resp_error:
                            resp_error = resp_error.split("ERROR:")[1].strip()
                        self.histstatus = resp_error
                    else:
                        error_flag = True

            # check for error in text/plain response
            if dict(self.response.headers)[
                    "Content-Type"].split(";")[0].strip() == "text/plain":
                resp_error = self.response.content.decode()
                if "Process is already started" in resp_error:
                    # do not consider this case as error
                    if "ERROR:" in resp_error:
                        resp_error = resp_error.split("ERROR:")[1].strip()
                    self.histstatus = resp_error
                else:
                    error_flag = True

        else:
            assert self.response != {}
            resp_error = self.response["error"]
            if resp_error != DEFAULT_ERROR_STR:
                if "Process is already started" in resp_error:
                    # do not consider this case as error
                    if "ERROR:" in resp_error:
                        resp_error = resp_error.split("ERROR:")[1].strip()
                    self.histstatus = resp_error
                else:
                    error_flag = True

        if error_flag:
            LOGGER.error("Mammoth endpoint status: {}".format(resp_error))
            raise SystemExit(
                "Migration Request with `cu = {} and "
                "data_category = {}` returned with error. Error: {}"
                .format(
                    self.cu,
                    self.data_category,
                    resp_error))
        else:
            resp_error = "NORMAL!" if resp_error == DEFAULT_ERROR_STR \
                else resp_error
            LOGGER.info("Mammoth endpoint status: {}".format(resp_error))

run()

def ody_migr_mmth_endpoint.MammothMigration.run

(

self

)

Connect to mammoth endpoint and fetch response json data

Definition at line 194 of file ody_migr_mmth_endpoint.py.

    def run(self):
        """Connect to mammoth endpoint and fetch response json data"""
        self._initiate_http_request()
        self._validate_response()
        return self.response

---

The documentation for this class was generated from the following file:

• app/tools/bin/ody_migr_mmth_endpoint.py