Unit tests for the v1 samples. Also replace (unused?) Travis config with GitHub Actions.

Daniel Abraham · copybara-github · commit 541907596717 · 2020-11-12T10:17:59.000-08:00
PiperOrigin-RevId: 342075553
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -0,0 +1,36 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python application
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        python -m pytest
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -47,5 +47,5 @@ directory of this repository (i.e. the directory which contains this `README.md`
 file):
 
 ```shell
-./samples/v1/<sample_name>.py -h
+python3 -m samples.v1.<sample_name> -h
 ```
diff --git a/samples/v1/cancel_operation.py b/samples/v1/cancel_operation.py
@@ -19,7 +19,7 @@
 import argparse
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/create_rule.py b/samples/v1/create_rule.py
@@ -18,7 +18,7 @@
 
 import argparse
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/delete_operation.py b/samples/v1/delete_operation.py
@@ -19,7 +19,7 @@
 import argparse
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/delete_rule.py b/samples/v1/delete_rule.py
@@ -19,7 +19,7 @@
 import argparse
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/enable_live_rule.py b/samples/v1/enable_live_rule.py
@@ -19,7 +19,7 @@
 import argparse
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/get_operation.py b/samples/v1/get_operation.py
@@ -22,7 +22,7 @@
 from typing import Optional
 
 import dataclasses
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/get_rule.py b/samples/v1/get_rule.py
@@ -19,7 +19,7 @@
 import argparse
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/list_operations.py b/samples/v1/list_operations.py
@@ -20,8 +20,8 @@
 import pprint
 from typing import Sequence
 
-import chronicle_auth
-import get_operation
+from . import chronicle_auth
+from . import get_operation
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
@@ -100,5 +100,5 @@ def list_operations(http_session: requests.AuthorizedSession,
   args = parser.parse_args()
   session = chronicle_auth.init_session(
       chronicle_auth.init_credentials(args.credentials_file))
-  operations = list_operations(session, args.page_size)
+  operations = list_operations(session, args.size_limit)
   pprint.pprint(operations)
diff --git a/samples/v1/list_results.py b/samples/v1/list_results.py
@@ -23,7 +23,7 @@
 import re
 from typing import Any, Mapping, Optional, Sequence, Tuple
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/list_rules.py b/samples/v1/list_rules.py
@@ -20,7 +20,7 @@
 import pprint
 from typing import Mapping, Sequence
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
@@ -75,13 +75,13 @@ def list_rules(http_session: requests.AuthorizedSession,
   chronicle_auth.add_argument_credentials_file(parser)
   parser.add_argument(
       "-ps",
-      "--page_size",
+      "--size_limit",
       type=int,
       default=0,
       help="maximum number of rules to return (default: 0 = no limit)")
 
   args = parser.parse_args()
   session = chronicle_auth.init_session(
       chronicle_auth.init_credentials(args.credentials_file))
-  rules = list_rules(session, args.page_size)
+  rules = list_rules(session, args.size_limit)
   pprint.pprint(rules)
diff --git a/samples/v1/run_rule.py b/samples/v1/run_rule.py
@@ -20,7 +20,7 @@
 import datetime
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/samples/v1/run_rule_and_wait.py b/samples/v1/run_rule_and_wait.py
@@ -26,11 +26,11 @@
 import time
 from typing import Any, Mapping, Sequence
 
-import cancel_operation
-import chronicle_auth
-import get_operation
-import list_results
-import run_rule
+from . import cancel_operation
+from . import chronicle_auth
+from . import get_operation
+from . import list_results
+from . import run_rule
 from google.auth.transport import requests
 
 DEFAULT_SLEEP_SECONDS = 5
diff --git a/samples/v1/update_rule.py b/samples/v1/update_rule.py
@@ -19,7 +19,7 @@
 import argparse
 import re
 
-import chronicle_auth
+from . import chronicle_auth
 from google.auth.transport import requests
 
 CHRONICLE_API_BASE_URL = "https://backstory.googleapis.com"
diff --git a/tests/v1/cancel_operation_test.py b/tests/v1/cancel_operation_test.py
@@ -0,0 +1,54 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Unit tests for the "cancel_operation" module."""
+
+import unittest
+from unittest import mock
+
+from google.auth.transport import requests
+from samples.v1 import cancel_operation
+
+
+class CancelOperationTest(unittest.TestCase):
+
+  @mock.patch.object(requests, "AuthorizedSession", autospec=True)
+  def test_operation_id_sanity_check(self, mock_session):
+    with self.assertRaises(ValueError):
+      cancel_operation.cancel_operation(mock_session, "invalid-operation-id")
+
+  @mock.patch.object(requests, "AuthorizedSession", autospec=True)
+  @mock.patch.object(requests.requests, "Response", autospec=True)
+  def test_http_error(self, mock_response, mock_session):
+    mock_session.request.return_value = mock_response
+    type(mock_response).status_code = mock.PropertyMock(return_value=400)
+    mock_response.raise_for_status.side_effect = (
+        requests.requests.exceptions.HTTPError())
+
+    with self.assertRaises(requests.requests.exceptions.HTTPError):
+      cancel_operation.cancel_operation(
+          mock_session, "rulejob_jo_12345678-1234-1234-1234-1234567890ab")
+
+  @mock.patch.object(requests, "AuthorizedSession", autospec=True)
+  @mock.patch.object(requests.requests, "Response", autospec=True)
+  def test_happy_path(self, mock_response, mock_session):
+    mock_session.request.return_value = mock_response
+    type(mock_response).status_code = mock.PropertyMock(return_value=200)
+
+    cancel_operation.cancel_operation(
+        mock_session, "rulejob_jo_12345678-1234-1234-1234-1234567890ab")
+
+
+if __name__ == "__main__":
+  unittest.main()
diff --git a/tests/v1/chronicle_auth_test.py b/tests/v1/chronicle_auth_test.py
@@ -0,0 +1,77 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Tests for the "chronicle_auth" module."""
+
+import os
+import tempfile
+import unittest
+
+from samples.v1 import chronicle_auth
+
+
+class ChronicleAuthTest(unittest.TestCase):
+
+  def setUp(self):
+    super().setUp()
+    fd, self.path = tempfile.mkstemp(suffix=".json", text=True)
+    fake_json_credentials = b"""{
+        "client_email": "fake-username@fake-project.iam.gserviceaccount.com",
+        "token_uri": "https://oauth2.googleapis.com/token",
+        "private_key": "
+    """
+    fake_private_key = b"""-----BEGIN PRIVATE KEY-----
+        MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDemycWcEiVMMKm
+        /S3f8oRkgxVvbi14D0TWFBUPZq9w1nc7L4Udz7NZ8BKC49DuKi1EgwxF8z0Bve5i
+        k6UMfb4JeXLkSSQN4Zy5IbZUr9Mm3w0sjIzTeA1JmIqY+r3EbUxeqFjpqc02HW4h
+        j0L7Wj2on9KTvMd0zFRCsLLz7KoZyykDKW3jbvDBNx9n3uUNBb+ZriYNbuAWCSlC
+        XD8QbVHq3dqFQFpsofHknDX/+UUS7Q85War4Y2qqdV7SwtTdy2LoNHKLLBHU0WMG
+        8x6PZueahkO2tipebJN6js4tSxSyk8sYFkU6onZJV91ysE+7QuS0HdhHTYfZSnC5
+        zHmJgyHVAgMBAAECggEABWtajsHKCpPG0WDtinuxfG7yiSVyBu+8OcgAYUEbOVCH
+        U5ILGBgz4hclpDken4W4V2gnVtaeoBm7IXw9summxD1ILkWXkpzw/1LSSQqExff9
+        Lp33Wbic/jMwAJxuHUeZ6d4IWBvxqoUZ5shBlbPzN1U4v68DXhURYhRCLw0OcRVE
+        9I3Ohwy6MntjHAkNTvFrYxQBUnCsTKFKwkimn6huhwE8/nrMpYS8H/8DxPFsBprw
+        AznRqWWfJ28yVoEzN+J1aIz631zk+LwSqY0m/TJra1uwMQ5J6bYqWlH8pS/UaI4s
+        6Lbhukubpi7P03XpP1aHMwCpwcsZ6hGD7XpELDZBgQKBgQD8fF2lgDcX0ksvcgk2
+        KKy4dPqwcONfB41lxbIYE9JZRo3hiWsAwQxfbW6Zt6cEdEqOnROw0jcaJhaKD+qf
+        d14ciUA+NjeHyE1yJjbytOnO7fx5wlVamHUI0ykFH4NoN+GOI7zt3kLIb20Zvqab
+        4Dt5e5qY5s+Mnr2wJVI8k4NcQQKBgQDhtFJ38bz7ehl9prTQ1AaAxAviU3XOBkko
+        uDTglE2aoKjc3qoWoX6vT0iamsM3EYYVZxxbqzjSUCrhpSetKdP/NZNN3mtMvFzj
+        ODXyhC43Ro3fVe+JvHzdxRtXbSwZ2GLmkbR8oyi7w4pU8rx9+/UfFOoiqcLIGQbb
+        N03t8TJwlQKBgB2fVblaHpyb3phVb8E76m/Fwbe7tuFqWGuNU0TB5pb00SaZ4cT3
+        4US86RH92wmJv0mWIj5Hm5Fk0JYoIeXNsmv0qmXiJIe4t2ViGGZHVXsirtF2PF9h
+        rbF4XMKuHNO4Yq0zgjICNqGfeRRhKtj06OVq3At+YPFlmmm1Jz3WLL5BAoGAQ3hL
+        Gs3px2cVjaky7iYjl4SDZPG8Co14ezKto+DRXgLe17+8Kq22GCPkOUtARgr4ARfk
+        s0Z44u3SE8fyF2Kkm+rhEOsHOlYokkfwYIHA6wctS/D9fTgaP5U3eigJgeRclD5E
+        LOn9ODvY81HopOSXvuXao+gJcRWCJi/fHNz4Tg0CgYEA0ruTbieHIzCjg8C1Sp40
+        GBixMpHsZ2ld1OaqQvidYIUL48TutyQhWHaRIqaziSZJBaNIYB73pIQfLdHIi0hx
+        3KHskc16JPhKgWLsl9cTP5GAIP2cqvSqBmnbvX+ArSRbqy4v7kxJwKPai+iaFi5H
+        1njcNc79W7qohKZshYNUq/0=
+        -----END PRIVATE KEY-----
+    """
+    fake_private_key = fake_private_key.replace(b" " * 4, b"")
+    fake_private_key = fake_private_key.replace(b"\n", b"\\n")
+    os.write(fd, fake_json_credentials.strip() + fake_private_key + b'"\n}\n')
+    os.close(fd)
+
+  def test_init_session_with_custom_json_credentials(self):
+    chronicle_auth.init_session(chronicle_auth.init_credentials(self.path))
+
+  def tearDown(self):
+    os.remove(self.path)
+    super().tearDown()
+
+
+if __name__ == "__main__":
+  unittest.main()
diff --git a/tests/v1/create_rule_test.py b/tests/v1/create_rule_test.py
@@ -0,0 +1,55 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""Unit tests for the "create_rule" module."""
+
+import unittest
+from unittest import mock
+
+from google.auth.transport import requests
+from samples.v1 import create_rule
+
+
+class CreateRuleTest(unittest.TestCase):
+
+  @mock.patch.object(requests, "AuthorizedSession", autospec=True)
+  def test_content_sanity_check(self, mock_session):
+    with self.assertRaises(ValueError):
+      create_rule.create_rule(mock_session, "")
+
+  @mock.patch.object(requests, "AuthorizedSession", autospec=True)
+  @mock.patch.object(requests.requests, "Response", autospec=True)
+  def test_http_error(self, mock_response, mock_session):
+    mock_session.request.return_value = mock_response
+    type(mock_response).status_code = mock.PropertyMock(return_value=400)
+    mock_response.raise_for_status.side_effect = (
+        requests.requests.exceptions.HTTPError())
+
+    with self.assertRaises(requests.requests.exceptions.HTTPError):
+      create_rule.create_rule(mock_session, "new rule content")
+
+  @mock.patch.object(requests, "AuthorizedSession", autospec=True)
+  @mock.patch.object(requests.requests, "Response", autospec=True)
+  def test_happy_path(self, mock_response, mock_session):
+    mock_session.request.return_value = mock_response
+    type(mock_response).status_code = mock.PropertyMock(return_value=200)
+    expected_rule_id = "ru_12345678-1234-1234-1234-1234567890ab"
+    mock_response.json.return_value = {"ruleId": expected_rule_id}
+
+    actual_rule_id = create_rule.create_rule(mock_session, "new rule content")
+    self.assertEqual(actual_rule_id, expected_rule_id)
+
+
+if __name__ == "__main__":
+  unittest.main()
diff --git a/tests/v1/delete_operation_test.py b/tests/v1/delete_operation_test.py
diff --git a/tests/v1/delete_rule_test.py b/tests/v1/delete_rule_test.py
diff --git a/tests/v1/enable_live_rule_test.py b/tests/v1/enable_live_rule_test.py
diff --git a/tests/v1/get_rule_test.py b/tests/v1/get_rule_test.py
diff --git a/tests/v1/list_rules_test.py b/tests/v1/list_rules_test.py
diff --git a/tests/v1/run_rule_and_wait_test.py b/tests/v1/run_rule_and_wait_test.py
