Add opctl integration tests (#265)

Author: liudmylaru

.pre-commit-config.yaml

@@ -13,6 +13,7 @@ repos:
         args: ['--allow-multiple-documents']
     -   id: detect-private-key
     -   id: end-of-file-fixer
+        exclude: '\.ipynb?$'
     -   id: pretty-format-json
         args: ['--autofix']
     -   id: trailing-whitespace

README-development.md

@@ -30,10 +30,10 @@ for development and testing purposes.
 Install Anaconda from `https://repo.continuum.io/miniconda/` for the operating system you are using.
 
 In the terminal client, enter the following where <yourenvname> is the name you want to call your environment,
-and set the Python version you want to use. ADS SDK requires Python >=3.7.
+and set the Python version you want to use. ADS SDK requires Python >=3.8.
 
 ```bash
-    conda create -n <yourenvname> python=3.7 anaconda
+    conda create -n <yourenvname> python=3.8 anaconda
 ```
 
 This installs the Python version and all the associated anaconda packaged libraries at `path_to_your_anaconda_location/anaconda/envs/<yourenvname>`
@@ -79,6 +79,61 @@ Use `ads_version.json` for versioning. The ADS SDK is packaged as a wheel. To ge
 
 This wheel can then be installed using `pip`.
 
+## Running tests
+
+The SDK uses pytest as its test framework.
+
+### Running default setup tests
+
+Default setup tests for testing ADS SDK without extra dependencies, specified in setup.py.
+
+```bash
+  # Update your environment with tests dependencies
+  pip install -r test-requirements.txt
+  # Run default setup tests
+  python3 -m pytest tests/unitary/default_setup
+```
+
+### Running all unit tests
+
+To run all unit test install extra dependencies to test all modules of ADS ASD.
+
+```bash
+  # Update your environment with tests dependencies
+  pip install -r dev-requirements.txt
+  # Run all unit tests
+  python3 -m pytest tests/unitary
+```
+
+### Running integration tests
+
+ADS opctl integration tests can't be run together with all other integration tests, they require special setup.
+To run all but opctl integration tests, you can run:
+
+```bash
+  # Update your environment with tests dependencies
+  pip install -r dev-requirements.txt
+  # Run integration tests
+  python3 -m pytest tests/integration --ignore=tests/integration/opctl
+```
+
+### Running opctl integration tests
+
+ADS opctl integration tests utilize cpu, gpu jobs images and need dataexpl_p37_cpu_v2 and pyspark30_p37_cpu_v3 Data Science Environments be installed, see the [About Conda Environments](https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm).
+To build development container, see the [Build Development Container Image](https://accelerated-data-science.readthedocs.io/en/latest/user_guide/cli/opctl/localdev/jobs_container_image.html).
+
+```bash
+  # Update your environment with tests dependencies
+  pip install -r test-requirements.txt
+  pip install -e ".[opctl]"
+  pip install oci oci-cli
+  # Build cpu and gpu jobs images
+  ads opctl build-image -d job-local
+  ads opctl build-image -g -d job-local  
+  # Run opclt integration tests
+  python3 -m pytest tests/integration/opctl
+```
+
 ## Security
 
 Consult the [security guide](./SECURITY.md) for our responsible security

ads/opctl/cmds.py

@@ -120,7 +120,7 @@ def __init__(self, config: Dict):
     @property
     def backend(self):
         if self._backend == BACKEND_NAME.LOCAL.value:
-            kind = self.config.get("kind")
+            kind = self.config.get("kind") or self.config["execution"].get("kind")
             if kind not in self.LOCAL_BACKENDS_MAP:
                 options = [backend for backend in self.LOCAL_BACKENDS_MAP.keys()]
                 # Special case local backend option not supported by this factory.

tests/conftest.py

@@ -2,26 +2,3 @@
 
 # Copyright (c) 2021, 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
-
-import pytest
-
-
-def pytest_addoption(parser):
-    parser.addoption(
-        "--opctl",
-        action="store_true",
-        default=False,
-        help="run opctl tests",
-    )
-
-
-def pytest_configure(config):
-    config.addinivalue_line("markers", "opctl: mark opctl tests")
-
-
-def pytest_collection_modifyitems(config, items):
-    if not config.getoption("--opctl"):
-        skip_opctl = pytest.mark.skip(reason="need --opctl option to run")
-        for item in items:
-            if "opctl" in item.keywords:
-                item.add_marker(skip_opctl)

tests/integration/opctl/__init__.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

tests/integration/opctl/opctl_tests_files/hello_world_test/__init__.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

tests/integration/opctl/opctl_tests_files/hello_world_test/folder/__init__.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

tests/integration/opctl/opctl_tests_files/hello_world_test/folder/test_mod.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+
+def test_import_nested():
+    print("This is an imported module from nested folder.")

tests/integration/opctl/opctl_tests_files/hello_world_test/main.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import argparse
+import os
+import json
+from test_mod import test_import
+from folder.test_mod import test_import_nested
+import ads
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-n", "--name", required=False, default="ADS")
+    args = parser.parse_args()
+    print(f"ADS {ads.__version__}")
+    print("Running user script...")
+    print(f"Hello World from {args.name}")
+    print("Printing environment variables...")
+    print(json.dumps(dict(os.environ), indent=2))
+    test_import()
+    test_import_nested()

tests/integration/opctl/opctl_tests_files/hello_world_test/operate.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import os
+from test_mod import test_import
+import ads
+
+
+def operate(spec=None, **kwargs):
+    print(f"ADS {ads.__version__}")
+    test_import()
+    print(kwargs["oci_auth"])
+    name = spec["name"] if spec else ""
+    print("Hello World", name)
+    if "TEST_ENV" in os.environ:
+        print(f"Test passing environment variables TEST_ENV={os.environ['TEST_ENV']}")