Corrects change from #13 which failed to return results to be written to file. (#15)

Signed-off-by: Caroline Russell <caroline@appthreat.dev>

Author: cerrussell

atom_tools/__init__.py

@@ -1,4 +1,4 @@
 """
 A cli, classes and functions for converting an atom slice to a different format
 """
-__version__ = '0.1.0'
+__version__ = '0.1.1'

atom_tools/cli/commands/convert.py

@@ -2,6 +2,7 @@
 Convert Command for the atom-tools CLI.
 """
 import json
+import logging
 
 from cleo.commands.command import Command
 from cleo.helpers import option
@@ -93,13 +94,19 @@ def handle(self):
                     self.option('format'),
                     self.option('type'),
                     self.option('usages-slice'),
-                    self.option('server'),
+                    # self.option('server'),
                     # self.option('reachables-slice'),
                 )
-                if result := converter.endpoints_to_openapi():
-                    with open(self.option('output-file'), 'w',
-                              encoding='utf-8') as f:
-                        json.dump(result, f, indent=4, sort_keys=True)
+
+                if not (result := converter.endpoints_to_openapi(
+                        self.option('server'))):
+                    logging.error('No results produced!')
+                    return 1
+                with open(self.option('output-file'), 'w',
+                          encoding='utf-8') as f:
+                    json.dump(result, f, indent=4, sort_keys=True)
+                logging.info(f'OpenAPI document written to '
+                             f'{self.option("output-file")}.')
             case _:
                 raise ValueError(
                     f'Unknown destination format: {self.option("format")}'

atom_tools/lib/converter.py

@@ -107,17 +107,14 @@ def __init__(
         dest_format: str,
         origin_type: str,
         usages: str,
-        server: str
     ) -> None:
         self.usages = AtomSlice(usages, origin_type)
         self.origin_type = origin_type
         self.openapi_version = dest_format.replace('openapi', '')
         self.title = f'OpenAPI Specification for {Path(usages).parent.stem}'
         self.regex = RegexCollection()
-        self.server = server
-        self.output: Dict[str, Any] = {}
 
-    def endpoints_to_openapi(self) -> None:
+    def endpoints_to_openapi(self, server: str = '') -> Any:
         """
         Generates an OpenAPI document with paths from usages.
         """
@@ -127,9 +124,10 @@ def endpoints_to_openapi(self) -> None:
             'info': {'title': self.title, 'version': '1.0.0'},
             'paths': paths_obj
         }
-        if self.server:
-            output['servers'] = list({'url': self.server})
-        self.output = output
+        if server:
+            output['servers'] = [{'url': server}]  # type: ignore[list-item]
+
+        return output
 
     def convert_usages(self) -> Dict[str, Any]:
         """

test/test_converter.py

@@ -6,34 +6,34 @@
 @pytest.fixture
 def java_usages_1():
     return OpenAPI('openapi3.1.0', 'java',
-                   'test/data/java-piggymetrics-usages.json', 'https://piggymetrics.com')
+                   'test/data/java-piggymetrics-usages.json')
 
 
 @pytest.fixture
 def java_usages_2():
     return OpenAPI('openapi3.0.1', 'java',
-                   'test/data/java-sec-code-usages.json', '')
+                   'test/data/java-sec-code-usages.json')
 
 
 @pytest.fixture
 def js_usages_1():
     return OpenAPI('openapi3.0.1', 'javascript',
-                   'test/data/js-juiceshop-usages.json', '')
+                   'test/data/js-juiceshop-usages.json')
 
 
 @pytest.fixture
 def js_usages_2():
-    return OpenAPI('openapi3.0.1', 'js', 'test/data/js-nodegoat-usages.json', '')
+    return OpenAPI('openapi3.0.1', 'js', 'test/data/js-nodegoat-usages.json')
 
 
 @pytest.fixture
 def py_usages_1():
-    return OpenAPI('openapi3.0.1', 'python', 'test/data/py-airflow-usages.json', '')
+    return OpenAPI('openapi3.0.1', 'python', 'test/data/py-airflow-usages.json')
 
 
 @pytest.fixture
 def py_usages_2():
-    return OpenAPI('openapi3.0.1', 'py', 'test/data/py-tornado-usages.json', '')
+    return OpenAPI('openapi3.0.1', 'py', 'test/data/py-tornado-usages.json')
 
 
 def test_populate_endpoints(js_usages_1, js_usages_2):
@@ -919,3 +919,30 @@ def test_convert_usages(java_usages_1, java_usages_2, js_usages_1, js_usages_2,
     #                                         }
     assert py_usages_2.convert_usages() == {'/': {}, '/auth/google': {},
                                             '/logout': {}}
+
+
+def test_endpoints_to_openapi(java_usages_1):
+
+    assert java_usages_1.endpoints_to_openapi() == {'info': {'title': 'OpenAPI Specification for data', 'version': '1.0.0'},
+ 'openapi': '3.1.0',
+ 'paths': {'/': {'post': {'responses': {}}},
+           '/accounts/{accountName}': {'get': {'responses': {}},
+                                       'parameters': [{'in': 'path',
+                                                       'name': 'accountName',
+                                                       'required': True}]},
+           '/current': {'get': {'responses': {}}, 'put': {'responses': {}}},
+           '/latest': {'get': {'responses': {}}},
+           '/statistics/{accountName}': {'parameters': [{'in': 'path',
+                                                         'name': 'accountName',
+                                                         'required': True}],
+                                         'put': {'responses': {}}},
+           '/uaa/users': {'post': {'responses': {}}},
+           '/{accountName}': {'get': {'responses': {}},
+                              'parameters': [{'in': 'path',
+                                              'name': 'accountName',
+                                              'required': True}],
+                              'put': {'responses': {}}},
+           '/{name}': {'get': {'responses': {}},
+                       'parameters': [{'in': 'path',
+                                       'name': 'name',
+                                       'required': True}]}}}