Added get_upcoming functions in targets (#13)

Added `get_upcoming()` function to targets plugin to get a list of upcoming targets
bamhm182 · Nov 12, 2022 · b8211a4 · b8211a4
1 parent 264f06e
commit b8211a4
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/docs/src/usage/plugins/targets.md b/docs/src/usage/plugins/targets.md
@@ -223,6 +223,16 @@
 >> [{"slug": "lfjpgmk",...},...]
 >> ```
 
+## targets.get_upcoming()
+
+> Gets a list of upcoming Targets from the Synack API.
+>
+>> Examples
+>> ```python3
+>> >>> h.targets.get_upcoming()
+>> [{'codename': 'SLEEPYSLUG', 'slug': '1o2h8o', 'category_name': 'Web Application', 'organization_name': 'SLEEPY Orgnization', 'upcoming_start_date': 1668430800}, ...]
+>> ```
+
 ## targets.set_connected(target, **kwargs)
 
 > Connect to a specified target

diff --git a/src/synack/plugins/targets.py b/src/synack/plugins/targets.py
@@ -219,6 +219,26 @@ def get_unregistered(self):
                 ret.append({'codename': t['codename'], 'slug': t['slug']})
         return ret
 
+    def get_upcoming(self):
+        """Get slugs and upcoming start dates of all upcoming targets"""
+        query = {
+                'filter[primary]': 'upcoming',
+                'filter[secondary]': 'all',
+                'filter[industry]': 'all',
+                'sorting[field]': 'upcomingStartDate',
+                'sorting[direction]': 'asc'
+        }
+        res = self.api.request('GET', 'targets', query=query)
+        ret = []
+        if res.status_code == 200:
+            for t in res.json():
+                ret.append({'codename': t['codename'],
+                            'slug': t['slug'],
+                            'category_name': t['category']['name'],
+                            'organization_name': t['organization']['name'],
+                            'upcoming_start_date': t['upcoming_start_date']})
+        return ret
+
     def set_connected(self, target=None, **kwargs):
         """Connect to a target"""
         slug = None

diff --git a/test/test_targets.py b/test/test_targets.py
@@ -389,6 +389,31 @@ def test_get_unregistered(self):
                                                     "targets",
                                                     query=query)
 
+    def test_get_upcoming(self):
+        """Should get a list upcoming targets"""
+        query = {
+            'filter[primary]': 'upcoming',
+            'filter[secondary]': 'all',
+            'filter[industry]': 'all',
+            'sorting[field]': 'upcomingStartDate',
+            'sorting[direction]': 'asc'
+        }
+        self.targets.api.request.return_value.status_code = 200
+        upcoming = [
+            {
+                "codename": "SLEEPYSLUG",
+                "slug": "1o2h8o",
+                'category_name': 'Web Application',
+                'organization_name': 'SLEEPY Orgnization',
+                'upcoming_start_date': 1668430800
+            }
+        ]
+        self.targets.api.request.return_value.json.return_value = upcoming
+        self.assertEqual(upcoming, self.targets.get_upcoming())
+        self.targets.api.request.assert_called_with("GET",
+                                                    "targets",
+                                                    query=query)
+
     def test_get_unregistered_assessments_empty(self):
         """Should get a list of unregistered targets"""
         self.targets.get_assessments = MagicMock()