test: Run integration tests on CI (#726)

Closes: SDK-2088

Author: lukaszsocha2

.github/workflows/integration-tests.yml

@@ -0,0 +1,30 @@
+name: Integration tests
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  tests:
+    name: Integration tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Python 3.6
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.6'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements-dev.txt
+      - name: Run integration tests
+        run: |
+          tox -e integration-tests
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          JWT_CONFIG_BASE_64: ${{ secrets.JWT_CONFIG_BASE_64 }}

pytest.ini

@@ -3,4 +3,6 @@ addopts = --strict --showlocals -r a --tb=long --ignore=test/integration_new/
 xfail_strict = True
 junit_suite_name = boxsdk
 testpaths = test/
+python_files=*.py
+
 

test/integration_new/README.md

@@ -1,8 +1,38 @@
-#Integration tests
+# Integration Tests
 
-To run integration tests locally you have to use a Box account with all possible scopes enabled.
-For integration tests we use JWT authentication method. To use it download jwt settings file from
-Developer Console and provide path to your config file in `integration_tests.cfg`.
+## Running integration tests locally
 
-To launch all integration tests locally run:
-`pytest test/integration_new/object/*`
+### Create Custom Application
+To run integration tests locally you will need a `Custom App` created at https://cloud.app.box.com/developers/console
+with `Server Authentication (with JWT)` selected as authentication method.
+Once created you can edit properties of the application:
+- In section `App Access Level` select `App + Enterprise Access`. You can enable all `Application Scopes`.
+- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.
+
+Now select `Authorization` and submit application to be reviewed by account admin.
+
+
+### Export configuration
+
+There are two ways to set up JWT configuration:
+1. First method:
+- Select `Configuration` tab and in the bottom in the section `App Settings`
+   download your app configuration settings as JSON.
+- Specify the path to the JWT config file in `integration_tests.cfg`, e.g. `ConfigFilePath = /Users/me/jwt-config.json`
+2. Alternatively:
+- Select `Configuration` tab and in the bottom in the section `App Settings`
+  download your app configuration settings as JSON.
+- Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`
+- Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file
+
+### Running Tests
+
+You can run all tests (unit in all supported python environments and integration) using command:
+```bash
+tox
+```
+
+To run only integration tests, you can run:
+```bash
+tox -e integration-tests
+```

test/integration_new/__init__.py

@@ -1,18 +1,46 @@
+import base64
 import configparser
 import os
+import json
 from pathlib import Path
+from typing import Optional
 
 from boxsdk.auth.jwt_auth import JWTAuth
 from boxsdk.client import Client
 
 
-def read_jwt_path_from_config(config_path: str):
+JWT_CONFIG_ENV_VAR_NAME = 'JWT_CONFIG_BASE_64'
+CURRENT_DIR_PATH = str(Path(os.path.realpath(os.path.join(os.getcwd(), os.path.dirname(__file__)))))
+CONFIG_PATH = f'{CURRENT_DIR_PATH}/integration_tests.cfg'
+
+
+def get_jwt_config() -> JWTAuth:
+    jwt_config = read_jwt_config_from_env_var() or read_jwt_config_from_file()
+
+    if not jwt_config:
+        raise RuntimeError(
+            f'JWT config cannot be loaded. Missing environment variable: {JWT_CONFIG_ENV_VAR_NAME} or JWT config path.'
+        )
+    return jwt_config
+
+
+def read_jwt_config_from_env_var() -> Optional[JWTAuth]:
+
+    jwt_config_base64 = os.getenv(JWT_CONFIG_ENV_VAR_NAME)
+    if not jwt_config_base64:
+        return None
+    jwt_config_str = base64.b64decode(jwt_config_base64)
+    jwt_config_json = json.loads(jwt_config_str)
+    return JWTAuth.from_settings_dictionary(jwt_config_json)
+
+
+def read_jwt_config_from_file() -> Optional[JWTAuth]:
     config_parser = configparser.ConfigParser()
-    config_parser.read(config_path)
-    return config_parser["JWT"].get('SettingsFilePath')
+    config_parser.read(CONFIG_PATH)
+    jwt_config_file_path = config_parser["JWT"].get('ConfigFilePath')
+    if not jwt_config_file_path:
+        return None
+    return JWTAuth.from_settings_file(jwt_config_file_path)
 
 
-CURRENT_DIR_PATH = str(Path(os.path.realpath(os.path.join(os.getcwd(), os.path.dirname(__file__)))))
-jwt_config_path = read_jwt_path_from_config(config_path=f'{CURRENT_DIR_PATH}/integration_tests.cfg')
-jwt_config = JWTAuth.from_settings_file(jwt_config_path)
-CLIENT = Client(jwt_config)
+CLIENT = Client(get_jwt_config())

test/integration_new/integration_tests.cfg

@@ -1,2 +1,2 @@
 [JWT]
-SettingsFilePath = PATH_TO_YOUR_JWT_CONFIG_FILE
+ConfigFilePath =

tox.ini

@@ -16,7 +16,8 @@ envlist =
   py39,
   py310,
   docs,
-  coverage
+  coverage,
+  integration-tests
 
 [gh-actions]
 python =
@@ -89,3 +90,9 @@ sitepackages = False
 recreate = True
 deps =
     twine
+
+[testenv:integration-tests]
+passenv = JWT_CONFIG_BASE_64
+commands =
+    pytest {toxinidir}/test/integration_new {posargs} --disable-pytest-warnings
+deps = -rrequirements-dev.txt