reanahub / reana-commons / 137

pending completion

Build # 137

Build Type

Pull #47

travis-ci

Committed by

web-flow

Commit Message

api_client: addition of BaseAPIClient

* ADD base class for instantiating SwaggerClients.

* ADD test_utils.py to be populated with common testing utilities.
  First utility is added, a method to create a SwaggerClient with a
  mock http_client, to be used just for validating API contracts.

Signed-off-by: Dinos Kousidis <dinos.kousidis@cern.ch>
(cherry picked from commit 6f98c09f5)

Pull Request Pull Request #47: api_client: addition of BaseAPIClient

Run Details

18 of 18 new or added lines in 1 file covered. (100.0%)

0 of 178 relevant lines covered (0.0%)

0.0 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/reana_commons/api_client.py

# -*- coding: utf-8 -*-
#
# This file is part of REANA.
# Copyright (C) 2018 CERN.
#
# REANA is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# REANA is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# REANA; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307, USA.
#
# In applying this license, CERN does not waive the privileges and immunities
# granted to it by virtue of its status as an Intergovernmental Organization or
# submit itself to any jurisdiction.
"""REANA REST API base client."""

import json
import os

import pkg_resources
from bravado.client import SwaggerClient


class BaseAPIClient(object):
    """REANA API client code."""

    def __init__(self, component, server_data, http_client=None):
        """Create a OpenAPI client for a REANA component."""
        self.component = component
        server_url, spec_file = server_data
        json_spec = self._get_spec(spec_file)
        self._client = SwaggerClient.from_spec(
            json_spec,
            http_client=http_client,
            config={'also_return_response': True})
        self._client.swagger_spec.api_url = server_url
        self.server_url = server_url

    def _get_spec(self, spec_file):
        """Get json specification from package data."""
        spec_file_path = os.path.join(
            pkg_resources.
            resource_filename(
                self.component,
                'openapi_connections'),
            spec_file)

        with open(spec_file_path) as f:
            json_spec = json.load(f)
        return json_spec

1	# -- coding: utf-8 --
2	#
3	# This file is part of REANA.
4	# Copyright (C) 2018 CERN.
5	#
6	# REANA is free software; you can redistribute it and/or modify it under the
7	# terms of the GNU General Public License as published by the Free Software
8	# Foundation; either version 2 of the License, or (at your option) any later
9	# version.
10	#
11	# REANA is distributed in the hope that it will be useful, but WITHOUT ANY
12	# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13	# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14	#
15	# You should have received a copy of the GNU General Public License along with
16	# REANA; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
17	# Suite 330, Boston, MA 02111-1307, USA.
18	#
19	# In applying this license, CERN does not waive the privileges and immunities
20	# granted to it by virtue of its status as an Intergovernmental Organization or
21	# submit itself to any jurisdiction.
22	"""REANA REST API base client."""	×
23
24	import json	×
25	import os	×
26
27	import pkg_resources	×
28	from bravado.client import SwaggerClient	×
29
30
31	class BaseAPIClient(object):	×
32	"""REANA API client code."""
33
34	def __init__(self, component, server_data, http_client=None):	×
35	"""Create a OpenAPI client for a REANA component."""
36	self.component = component	×
37	server_url, spec_file = server_data	×
38	json_spec = self._get_spec(spec_file)	×
39	self._client = SwaggerClient.from_spec(	×
40	json_spec,
41	http_client=http_client,
42	config={'also_return_response': True})
43	self._client.swagger_spec.api_url = server_url	×
44	self.server_url = server_url	×
45
46	def _get_spec(self, spec_file):	×
47	"""Get json specification from package data."""
48	spec_file_path = os.path.join(	×
49	pkg_resources.
50	resource_filename(
51	self.component,
52	'openapi_connections'),
53	spec_file)
54
55	with open(spec_file_path) as f:	×
56	json_spec = json.load(f)	×
57	return json_spec	×

reanahub / reana-commons / 137

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous