atom-tools 0.8.2__tar.gz → 0.8.4__tar.gz

{atom_tools-0.8.2/atom_tools.egg-info → atom_tools-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atom-tools
-Version: 0.8.2
+Version: 0.8.4
 Summary: Collection of tools for use with AppThreat/atom.
 Author-email: Caroline Russell <caroline@appthreat.dev>
 License-Expression: MIT

{atom_tools-0.8.2 → atom_tools-0.8.4}/atom_tools/__init__.py

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

{atom_tools-0.8.2 → atom_tools-0.8.4}/atom_tools/lib/converter.py

@@ -71,7 +71,11 @@ class OpenAPI:
         self.target_line_nums = self._identify_target_line_nums(methods)
         self.file_endpoint_map = self.create_file_to_method_dict(methods)
         methods = self._process_calls(methods)
-        return self.populate_endpoints(methods)
+        paths = self.populate_endpoints(methods)
+        udt_methods = self._extract_methods_from_udt()
+        if udt_methods:
+            paths = merge_path_objects(paths, udt_methods)
+        return paths
 
     def create_file_to_method_dict(self, method_map: Dict[str, Any]) -> Dict[str, List]:
         """
@@ -149,8 +153,16 @@ class OpenAPI:
             dict: A new method map containing endpoints.
         """
         new_method_map: Dict = {'file_names': {}}
+        class_prefixes = self._get_java_class_prefixes()
         for file_name, resolved_methods in method_map.items():
             if new_resolved := self._process_resolved_methods(resolved_methods):
+                prefix = class_prefixes.get(file_name, '')
+                if prefix:
+                    for method_key in new_resolved:
+                        new_resolved[method_key]['endpoints'] = [
+                            prefix.rstrip('/') + ep
+                            for ep in new_resolved[method_key]['endpoints']
+                        ]
                 new_method_map['file_names'][file_name] = {'resolved_methods': new_resolved}
         return new_method_map
 
@@ -437,6 +449,93 @@ class OpenAPI:
             self.params[new_endpoint] = params
         return new_endpoint.replace("/{}", "/")
 
+    def _extract_methods_from_udt(self) -> Dict[str, Any]:
+        """
+        Extract HTTP method and endpoint pairings from userDefinedTypes fields.
+
+        Handles custom router patterns where HTTP method and path are both
+        fields in the same userDefinedType entry (e.g., registerRoute('get', '/')).
+
+        Returns:
+            dict: A paths object mapping endpoints to their HTTP method operations.
+        """
+        ops = {'get', 'put', 'post', 'delete', 'options', 'head', 'patch'}
+        pattern = jmespath.compile(
+            'userDefinedTypes[].{file_name: fileName, line_number: lineNumber,'
+            ' fields: fields[].name}'
+        )
+        result = pattern.search(self.usages.content)
+        if not result:
+            return {}
+        paths_object: Dict = {}
+        for entry in result:
+            fields = entry.get('fields') or []
+            file_name = entry.get('file_name', '')
+            line_number = entry.get('line_number')
+            found_ops = [f.strip('"').strip("'") for f in fields
+                         if f and f.strip('"').strip("'").lower() in ops]
+            found_paths = [f.strip('"').strip("'") for f in fields
+                           if f and '/' in f]
+            if not found_ops or not found_paths:
+                continue
+            for ep in found_paths:
+                ep = self._parse_path_regexes(ep)
+                path_item: Dict = {}
+                for op in found_ops:
+                    path_item[op.lower()] = {'responses': {}}
+                if line_number and file_name:
+                    ln_entry = create_ln_entries(
+                        file_name, [line_number], None
+                    )
+                    path_item.update(ln_entry)
+                if paths_object.get(ep):
+                    paths_object[ep] = merge_path_objects(
+                        paths_object[ep], path_item
+                    )
+                else:
+                    paths_object[ep] = path_item
+        return paths_object
+
+    def _get_java_class_prefixes(self) -> Dict[str, str]:
+        """
+        Scans objectSlices for class-level mapping annotations in
+        Java/Spring Boot and returns a map of {fileName: prefix_path}.
+
+        In Spring Boot, a @RequestMapping (or any mapping variant like
+        @GetMapping, @PostMapping, etc.) on the class itself acts as a URL
+        prefix for all methods in that class. These entries appear in
+        objectSlices with an empty usages list and the annotation text in
+        the 'code' field.
+
+        Returns:
+            dict: A mapping of file name to its class-level URL path prefix.
+                  Empty dict for non-Java origins.
+        """
+        if self.usages.origin_type not in ('java', 'jar'):
+            return {}
+        class_mapping_annotations = (
+            '@RequestMapping', '@GetMapping', '@PostMapping',
+            '@PutMapping', '@DeleteMapping', '@PatchMapping',
+        )
+        prefixes: Dict[str, str] = {}
+        object_slices = self.usages.content.get('objectSlices', [])
+        for entry in object_slices:
+            code = entry.get('code', '') or ''
+            file_name = entry.get('fileName', '') or ''
+            usages = entry.get('usages', [])
+            # Class-level annotations appear with empty usages and the
+            # annotation text in 'code'. We check for all Spring Boot
+            # mapping variants that carry a URL path (contains '/').
+            if (usages == []
+                    and code.startswith(class_mapping_annotations)
+                    and '/' in code
+                    and file_name
+                    and file_name not in prefixes):
+                extracted = self._extract_endpoints(code)
+                if extracted:
+                    prefixes[file_name] = extracted[0]
+        return prefixes
+
     def _process_calls(self, method_map: Dict) -> Dict[str, Any]:
         """
         Process calls and return a new method map.

{atom_tools-0.8.2 → atom_tools-0.8.4/atom_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: atom-tools
-Version: 0.8.2
+Version: 0.8.4
 Summary: Collection of tools for use with AppThreat/atom.
 Author-email: Caroline Russell <caroline@appthreat.dev>
 License-Expression: MIT

{atom_tools-0.8.2 → atom_tools-0.8.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "atom-tools"
-version = "0.8.2"
+version = "0.8.4"
 description = "Collection of tools for use with AppThreat/atom."
 authors = [
   { name = "Caroline Russell", email = "caroline@appthreat.dev" },

{atom_tools-0.8.2 → atom_tools-0.8.4}/test/test_converter.py

@@ -135,15 +135,15 @@ def test_endpoints_to_openapi(java_usages_1):
                         'put': {'responses': {}},
                         'x-atom-usages': {'call': {'account-service/src/main/java/com/piggymetrics/account/controller/AccountController.java': [25,
                                                                                                                                                 30],
-                                                   'auth-service/src/main/java/com/piggymetrics/auth/controller/UserController.java': [22],
-                                                   'notification-service/src/main/java/com/piggymetrics/notification/controller/RecipientController.java': [21,
-                                                                                                                                                            26],
                                                    'statistics-service/src/main/java/com/piggymetrics/statistics/controller/StatisticsController.java': [20]},
-                                          'target': {'account-service/src/main/java/com/piggymetrics/account/controller/AccountController.java': [30],
-                                                     'auth-service/src/main/java/com/piggymetrics/auth/controller/UserController.java': [22],
-                                                     'notification-service/src/main/java/com/piggymetrics/notification/controller/RecipientController.java': [26]}}},
+                                          'target': {'account-service/src/main/java/com/piggymetrics/account/controller/AccountController.java': [30]}}},
            '/latest': {'get': {'responses': {}},
                        'x-atom-usages': {'call': {'statistics-service/src/main/java/com/piggymetrics/statistics/client/ExchangeRatesClient.java': [13]}}},
+           '/recipients/current': {'get': {'responses': {}},
+                                   'put': {'responses': {}},
+                                   'x-atom-usages': {'call': {'notification-service/src/main/java/com/piggymetrics/notification/controller/RecipientController.java': [21,
+                                                                                                                                                                       26]},
+                                                     'target': {'notification-service/src/main/java/com/piggymetrics/notification/controller/RecipientController.java': [26]}}},
            '/statistics/{accountName}': {'parameters': [{'in': 'path',
                                                          'name': 'accountName',
                                                          'required': True}],
@@ -151,6 +151,9 @@ def test_endpoints_to_openapi(java_usages_1):
                                          'x-atom-usages': {'call': {'account-service/src/main/java/com/piggymetrics/account/client/StatisticsServiceClient.java': [13]}}},
            '/uaa/users': {'post': {'responses': {}},
                           'x-atom-usages': {'call': {'account-service/src/main/java/com/piggymetrics/account/client/AuthServiceClient.java': [12]}}},
+           '/users/current': {'get': {'responses': {}},
+                              'x-atom-usages': {'call': {'auth-service/src/main/java/com/piggymetrics/auth/controller/UserController.java': [22]},
+                                                'target': {'auth-service/src/main/java/com/piggymetrics/auth/controller/UserController.java': [22]}}},
            '/{accountName}': {'get': {'responses': {}},
                               'parameters': [{'in': 'path',
                                               'name': 'accountName',
@@ -1356,3 +1359,36 @@ def test_rb(rb_usages_1):
 def test_rb_with_endpoints(rb_usages_2):
     result = ruby_convert(rb_usages_2.usages)
     assert result
+
+
+@pytest.fixture
+def ts_usages_1():
+    return OpenAPI('openapi3.0.1', 'typescript',
+                   'test/data/ts-custom-router-usages.json')
+
+
+def test_ts_custom_router(ts_usages_1):
+    result = ts_usages_1.convert_usages()
+    result = sort_openapi_result(result)
+    assert result
+    # Verify HTTP methods are present for endpoints with registerRoute pattern
+    assert '/' in result
+    assert 'get' in result['/']
+    assert 'post' in result['/']
+    assert '/complex' in result
+    assert 'get' in result['/complex']
+
+
+def test_ts_custom_router_openapi(ts_usages_1):
+    result = ts_usages_1.endpoints_to_openapi()
+    result = sort_openapi_result(result)
+    paths = result['paths']
+    # Check that methods from registerRoute are populated
+    assert 'get' in paths['/']
+    assert 'post' in paths['/']
+    assert 'get' in paths['/complex']
+    # Verify the standard paths also exist
+    assert '/api' in paths
+    assert '/items' in paths
+    assert '/users' in paths
+    assert '/render' in paths