ci: Add CI for Pull Requests (#130)

* ci: Add CI for Pull Requests
* fix(ci): Add sudo to install OS dependencies
* fix(ci): Install dependencies
* fix(ci): Transform examples from Python 2 to Python 3
* fix(monitor): Solve JSON serialiation of map function
* fix(ci): Do not fail if there are no events in the feed
* fix(examples): Fill the filter if is none
* chore: Force safe YAML load
* feat: Split Policy events client (#131)
* ci: Solve some PEP 8 problems
* ci: Add flake8 to dev dependencies
* fix(utils): Solve unknown reference to function
* feat: Split Secure client into PolicyEvents clients
* chore: Increase version number
* chore: Add dependency to include secure package
* chore: Update setup.py with pipenv-setup and remove requirements
* fix(ci): Update get_policy_events_duration interface result
* fix(ci): Remove offset field, as is unused
* fix(example): The loop should be stopped if the cursor is none
* chore: Add deprecation notice in the PolicyEventsClientOld class
* chore: Increase deprecation notice warning level
* fix(ci): Do not assert non-empty event list

Author: tembleking

.github/workflows/ci-pull-request.yml

@@ -0,0 +1,71 @@
+name: CI - Pull Request
+
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+
+    - name: Install pipenv
+      run: python -m pip install pipenv
+
+    - uses: actions/cache@v2
+      with:
+        path: ~/.cache
+        key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-pipenv-
+
+    - name: Get dependencies
+      run: pipenv install -d
+
+    - name: Lint
+      continue-on-error: true
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        pipenv run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        pipenv run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+    - name: Travis Test - Start agent
+      id: start_agent
+      env:
+        PYTHON_SDC_TEST_ACCESS_KEY: ${{ secrets.STAGING_AGENT_KEY }}
+      run: |
+        sudo apt-get install linux-headers-$(uname -r) dkms gcc-multilib g++-multilib
+        ./test/start_agent.sh
+
+    - name: Travis Test - Install dependencies
+      run: pip install .
+
+    - name: Travis Test - Monitor APIs
+      env:
+        PYTHON_SDC_TEST_MONITOR_API_TOKEN: ${{ secrets.STAGING_MONITOR_API_TOKEN }}
+      run: ./test/test_monitor_apis.sh
+
+    - name: Travis Test - Secure APIs
+      env:
+        PYTHON_SDC_TEST_API_TOKEN: ${{ secrets.STAGING_SECURE_API_TOKEN }}
+      run: ./test/test_secure_apis.sh
+
+    - name: Travis Test - Stop agent
+      run: ./test/stop_agent.sh
+      if: steps.start_agent.outcome == 'success'
+
+    - name: Test in staging
+      env:
+        SDC_MONITOR_TOKEN: ${{ secrets.STAGING_MONITOR_API_TOKEN }}
+        SDC_SECURE_TOKEN: ${{ secrets.STAGING_SECURE_API_TOKEN }}
+        SDC_MONITOR_URL: "https://app-staging.sysdigcloud.com"
+        SDC_SECURE_URL: "https://secure-staging.sysdig.com"
+      run: |
+        pipenv run mamba -f documentation

.gitignore

@@ -58,3 +58,9 @@ target/
 
 # virtualenv
 venv/
+
+# Direnv
+.envrc
+
+# IntelliJ projects
+.idea/

Pipfile

@@ -8,7 +8,9 @@ mamba = "*"
 doublex = "*"
 doublex-expects = "*"
 expects = "*"
-sdcclient = {editable = true,path = "."}
+flake8 = "*"
+pipenv-setup = "*"
+sdcclient = {editable = true, path = "."}
 
 [packages]
 requests = "*"

Pipfile.lock

@@ -3,16 +3,15 @@
 # Post a user event to Sysdig Cloud
 #
 
-import os
 import sys
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+
 from sdcclient import SdcClient
 
 #
 # Parse arguments
 #
 if len(sys.argv) != 3:
-    print('usage: %s <sysdig-token> email' % sys.argv[0])
+    print(('usage: %s <sysdig-token> email' % sys.argv[0]))
     print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
     sys.exit(1)
 

examples/add_notification_email.py

@@ -3,15 +3,14 @@
 # Add a new policy
 #
 
-import os
-import sys
 import json
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+import sys
+
 from sdcclient import SdSecureClient
 
 
 def usage():
-    print('usage: %s <sysdig-token>' % sys.argv[0])
+    print(('usage: %s <sysdig-token>' % sys.argv[0]))
     print('Reads policy json from standard input')
     print('You can find your token at https://secure.sysdig.com/#/settings/user')
     sys.exit(1)
@@ -38,7 +37,7 @@ def usage():
 # Return the result
 #
 if ok:
-    print(json.dumps(res, indent=2))
+    print((json.dumps(res, indent=2)))
 else:
     print(res)
     sys.exit(1)

examples/add_policy.py

@@ -3,15 +3,14 @@
 # Add a new policy
 #
 
-import os
-import sys
 import json
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+import sys
+
 from sdcclient import SdSecureClientV1
 
 
 def usage():
-    print('usage: %s <sysdig-token>' % sys.argv[0])
+    print(('usage: %s <sysdig-token>' % sys.argv[0]))
     print('Reads policy json from standard input')
     print('You can find your token at https://secure.sysdig.com/#/settings/user')
     sys.exit(1)
@@ -38,7 +37,7 @@ def usage():
 # Return the result
 #
 if ok:
-    print(json.dumps(res, indent=2))
+    print((json.dumps(res, indent=2)))
 else:
     print(res)
     sys.exit(1)

examples/add_policy_v1.py

@@ -12,18 +12,15 @@
 # of the Secure Operations team as well.
 #
 
-import os
 import sys
-import json
-import logging
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+
 from sdcclient import SdcClient
 
 #
 # Parse arguments
 #
 if len(sys.argv) != 2:
-    print('usage: %s <sysdig-token>' % sys.argv[0])
+    print(('usage: %s <sysdig-token>' % sys.argv[0]))
     print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
     sys.exit(1)
 
@@ -47,14 +44,14 @@
 ok, res = sdclient.list_memberships(SECURE_TEAM_NAME)
 
 if not ok:
-    print('Unable to get memberships for ' + SECURE_TEAM_NAME + ' team: ', res)
+    print(('Unable to get memberships for ' + SECURE_TEAM_NAME + ' team: ', res))
     sys.exit(1)
 memberships = res
 
 ok, res = sdclient.get_users()
 
 if not ok:
-    print('Unable to get users: ', res)
+    print(('Unable to get users: ', res))
     sys.exit(1)
 all_users = res
 
@@ -64,16 +61,16 @@
 #
 for user in all_users:
     if user['username'] in memberships:
-        print('Will preserve existing membership for: ' + user['username'])
+        print(('Will preserve existing membership for: ' + user['username']))
     else:
-        print('Will add new member: ' + user['username'])
+        print(('Will add new member: ' + user['username']))
         memberships[user['username']] = SECURE_TEAM_ROLE
 
 ok, res = sdclient.save_memberships(SECURE_TEAM_NAME, memberships=memberships)
 if not ok:
-    print('Could not edit team:', res, '. Exiting.')
+    print(('Could not edit team:', res, '. Exiting.'))
     sys.exit(1)
 else:
-    print('Finished syncing memberships of "' + SECURE_TEAM_NAME + '" team')
+    print(('Finished syncing memberships of "' + SECURE_TEAM_NAME + '" team'))
 
 sys.exit(0)

examples/add_users_to_secure.py

@@ -7,17 +7,16 @@
 #
 
 import getopt
-import os
 import sys
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+
 from sdcclient import SdcClient
 
 
 #
 # Parse arguments
 #
 def usage():
-    print('usage: %s [-a|--alert <name>] <sysdig-token>' % sys.argv[0])
+    print(('usage: %s [-a|--alert <name>] <sysdig-token>' % sys.argv[0]))
     print('-a|--alert: Set name of alert to create')
     print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
     sys.exit(1)
@@ -53,7 +52,7 @@ def usage():
 
 ok, res = sdclient.get_notification_ids(notify_channels)
 if not ok:
-    print("Could not get IDs and hence not creating the alert: " + res)
+    print(("Could not get IDs and hence not creating the alert: " + res))
     sys.exit(-1)
 
 notification_channel_ids = res
@@ -68,8 +67,10 @@ def usage():
     60,  # The alert will fire if the condition is met for at least 60 seconds.
     'avg(cpu.used.percent) > 80',  # The condition.
     ['host.mac', 'proc.name'],  # Segmentation. We want to check this metric for every process on every machine.
-    'ANY',  # in case there is more than one tomcat process, this alert will fire when a single one of them crosses the 80% threshold.
-    'proc.name = "tomcat"',  # Filter. We want to receive a notification only if the name of the process meeting the condition is 'tomcat'.
+    'ANY',
+    # in case there is more than one tomcat process, this alert will fire when a single one of them crosses the 80% threshold.
+    'proc.name = "tomcat"',
+    # Filter. We want to receive a notification only if the name of the process meeting the condition is 'tomcat'.
     notification_channel_ids,
     False)  # This alert will be disabled when it's created.
 

examples/create_alert.py

@@ -7,17 +7,16 @@
 #
 
 import getopt
-import os
 import sys
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))
+
 from sdcclient import SdMonitorClient
 
 
 #
 # Parse arguments
 #
 def usage():
-    print('usage: %s [-d|--dashboard <name>] <sysdig-token>' % sys.argv[0])
+    print(('usage: %s [-d|--dashboard <name>] <sysdig-token>' % sys.argv[0]))
     print('-d|--dashboard: Set name of dashboard to create')
     print('You can find your token at https://app.sysdigcloud.com/#/settings/user')
     sys.exit(1)