From f27a0eb2b79e4e097960488d6a9ca19fa7985e34 Mon Sep 17 00:00:00 2001
From: Claudiu Belu <cbelu@cloudbasesolutions.com>
Date: Mon, 29 Jul 2024 11:16:55 +0000
Subject: [PATCH] Adds tox.ini and basic rock test

Adds the following tox targets: fmt, lint, sanity, integration.

Adds basic rock test, checking that the expected file exists in the
rock, and checking the added executable output.
---
 tests/.copyright.tmpl                    |  1 +
 tests/integration/test_csi_driver_nfs.py |  8 +++
 tests/requirements-dev.txt               |  5 ++
 tests/requirements-test.txt              |  5 ++
 tests/sanity/test_csi_driver_nfs.py      | 23 ++++++++
 tests/tox.ini                            | 72 ++++++++++++++++++++++++
 6 files changed, 114 insertions(+)
 create mode 100644 tests/.copyright.tmpl
 create mode 100644 tests/integration/test_csi_driver_nfs.py
 create mode 100644 tests/requirements-dev.txt
 create mode 100644 tests/requirements-test.txt
 create mode 100644 tests/sanity/test_csi_driver_nfs.py
 create mode 100644 tests/tox.ini

diff --git a/tests/.copyright.tmpl b/tests/.copyright.tmpl
new file mode 100644
index 0000000..ecbed6c
--- /dev/null
+++ b/tests/.copyright.tmpl
@@ -0,0 +1 @@
+Copyright ${years} ${owner}.
diff --git a/tests/integration/test_csi_driver_nfs.py b/tests/integration/test_csi_driver_nfs.py
new file mode 100644
index 0000000..09b7cd8
--- /dev/null
+++ b/tests/integration/test_csi_driver_nfs.py
@@ -0,0 +1,8 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+
+
+def test_csi_driver_nfs_integration():
+    """Test NFS CSI driver rock."""
+    pass
diff --git a/tests/requirements-dev.txt b/tests/requirements-dev.txt
new file mode 100644
index 0000000..a66721a
--- /dev/null
+++ b/tests/requirements-dev.txt
@@ -0,0 +1,5 @@
+black==24.3.0
+codespell==2.2.4
+flake8==6.0.0
+isort==5.12.0
+licenseheaders==0.8.8
diff --git a/tests/requirements-test.txt b/tests/requirements-test.txt
new file mode 100644
index 0000000..ff57d6b
--- /dev/null
+++ b/tests/requirements-test.txt
@@ -0,0 +1,5 @@
+coverage[toml]==7.2.5
+pytest==7.3.1
+PyYAML==6.0.1
+tenacity==8.2.3
+git+https://github.com/canonical/k8s-test-harness.git@main
diff --git a/tests/sanity/test_csi_driver_nfs.py b/tests/sanity/test_csi_driver_nfs.py
new file mode 100644
index 0000000..e504521
--- /dev/null
+++ b/tests/sanity/test_csi_driver_nfs.py
@@ -0,0 +1,23 @@
+#
+# Copyright 2024 Canonical, Ltd.
+#
+
+from k8s_test_harness.util import docker_util, env_util
+
+ROCK_EXPECTED_FILES = [
+    "/nfsplugin",
+]
+
+
+def test_csi_driver_nfs_rock():
+    """Test NFS CSI driver rock."""
+
+    rock = env_util.get_build_meta_info_for_rock_version("nfsplugin", "4.7.0", "amd64")
+    image = rock.image
+
+    # check rock filesystem.
+    docker_util.ensure_image_contains_paths(image, ROCK_EXPECTED_FILES)
+
+    # check binary.
+    process = docker_util.run_in_docker(image, ["/nfsplugin", "--help"])
+    assert "Usage of /nfsplugin:" in process.stderr
diff --git a/tests/tox.ini b/tests/tox.ini
new file mode 100644
index 0000000..ffc76ce
--- /dev/null
+++ b/tests/tox.ini
@@ -0,0 +1,72 @@
+[tox]
+no_package = True
+skip_missing_interpreters = True
+env_list = format, lint, integration
+min_version = 4.0.0
+
+[testenv]
+set_env =
+    PYTHONBREAKPOINT=pdb.set_trace
+    PY_COLORS=1
+pass_env =
+    PYTHONPATH
+
+[testenv:format]
+description = Apply coding style standards to code
+deps = -r {tox_root}/requirements-dev.txt
+commands =
+    licenseheaders -t {tox_root}/.copyright.tmpl -cy -o 'Canonical, Ltd' -d {tox_root}/sanity
+    licenseheaders -t {tox_root}/.copyright.tmpl -cy -o 'Canonical, Ltd' -d {tox_root}/integration
+    isort {tox_root}/sanity {tox_root}/integration --profile=black
+    black {tox_root}/sanity {tox_root}/integration
+
+[testenv:lint]
+description = Check code against coding style standards
+deps = -r {tox_root}/requirements-dev.txt
+commands =
+    codespell {tox_root}/sanity {tox_root}/integration
+    flake8 {tox_root}/sanity {tox_root}/integration
+    licenseheaders -t {tox_root}/.copyright.tmpl -cy -o 'Canonical, Ltd' -d {tox_root}/sanity --dry
+    licenseheaders -t {tox_root}/.copyright.tmpl -cy -o 'Canonical, Ltd' -d {tox_root}/integration --dry
+    isort {tox_root}/sanity {tox_root}/integration --profile=black --check
+    black {tox_root}/sanity {tox_root}/integration --check --diff
+
+[testenv:sanity]
+description = Run integration tests
+deps =
+    -r {tox_root}/requirements-test.txt
+commands =
+    pytest -v \
+        --maxfail 1 \
+        --tb native \
+        --log-cli-level DEBUG \
+        --disable-warnings \
+        {posargs} \
+        {tox_root}/sanity
+pass_env =
+    TEST_*
+    ROCK_*
+    BUILT_ROCKS_METADATA
+
+[testenv: integration]
+description = Run integration tests
+deps = -r {tox_root}/requirements-test.txt
+commands =
+    pytest -v \
+        --maxfail 1 \
+        --tb native \
+        --log-cli-level DEBUG \
+        --disable-warnings \
+        {posargs} \
+        {tox_root}/integration
+pass_env =
+    TEST_*
+    ROCK_*
+    BUILT_ROCKS_METADATA
+
+[flake8]
+max-line-length = 120
+select = E,W,F,C,N
+ignore = W503
+exclude = venv,.git,.tox,.tox_env,.venv,build,dist,*.egg_info
+show-source = true