DCGM snap tests

.gitignore

@@ -1,8 +1,21 @@
 # This is a template `.gitignore` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
 # Tests files and dir
+.pytest_cache/
+.coverage
+.tox
+.venv
 reports/
 **/report/
+htmlcov/
+.mypy_cache
 
 # Log files
 *.log
@@ -17,9 +30,14 @@ reports/
 # version data
 repo-info
 
+# Python builds
+deb_dist/
+dist/
+*.egg-info/
+
 # Snaps
 *.snap
 
 # Builds
 .build/
-build/
+build/

Makefile

@@ -0,0 +1,55 @@
+# This is a template `Makefile` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+PYTHON := /usr/bin/python3
+
+PROJECTPATH=$(dir $(realpath ${MAKEFILE_LIST}))
+SNAP_NAME=$(shell cat ${PROJECTPATH}/snap/snapcraft.yaml | grep -E '^name:' | awk '{print $$2}')
+SNAP_FILE=${PROJECTPATH}/${SNAP_NAME}.snap
+
+help:
+	@echo "This project supports the following targets"
+	@echo ""
+	@echo " make help - show this text"
+	@echo " make clean - remove unneeded files"
+	@echo " make build - build the snap"
+	@echo " make lint - run lint checkers"
+	@echo " make reformat - run lint tools to auto format code"
+	@echo " make unittests - run the tests defined in the unittest subdirectory"
+	@echo " make functional - run the tests defined in the functional subdirectory"
+	@echo " make test - run lint, proof, unittests and functional targets"
+	@echo ""
+
+lint:
+	@echo "Running lint checks"
+	@tox -e lint
+
+unittests:
+	@echo "Running unit tests"
+	@tox -e unit -- ${UNIT_ARGS}
+
+test: lint unittests functional
+	@echo "Tests completed for the snap."
+
+reformat:
+	@echo "Reformat files with black and isort"
+	@tox -e reformat
+
+build:
+	@echo "Building the snap"
+	@snapcraft --use-lxd
+	@bash -c ./rename.sh
+
+clean:
+	@echo "Cleaning snap"
+	@snapcraft clean --use-lxd
+	@echo "Cleaning existing snap builds"
+	@rm -rf ${SNAP_FILE}
+
+functional: build
+	@echo "Executing functional tests using built snap"
+	@TEST_SNAP=${SNAP_FILE} tox -e func -- ${FUNC_ARGS}
+
+# The targets below don't depend on a file
+.PHONY: help clean build lint reformat unittests functional test

README.md

@@ -1,4 +1,4 @@
-# dcgm-snap
+# DCGM Snap
 
 This is a snap delivering NVIDIA dcgm components.
 The snap consists of [dcgm](https://developer.nvidia.com/dcgm) and [dcgm-exporter](https://github.com/NVIDIA/dcgm-exporter).
@@ -8,5 +8,12 @@ The snap consists of [dcgm](https://developer.nvidia.com/dcgm) and [dcgm-exporte
 You can build the snap locally by using the command:
 
 ```shell
-snapcraft --use-lxd
-```
+make build
+```
+
+## Install the snap
+
+```shell
+snap install --dangerous ./dcgm.snap
+sudo systemctl enable snap.dcgm.dcgm-exporter.service --now # enable and start dcgm-exporter service
+```

pyproject.toml

@@ -0,0 +1,66 @@
+# This is a template `pyproject.toml` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+[tool.flake8]
+ignore = ["C901", "D100", "D101", "D102", "D103", "W503", "W504"]
+exclude = ['.eggs', '.git', '.tox', '.venv', '.build', 'build', 'report']
+max-line-length = 99
+max-complexity = 10
+
+[tool.black]
+line-length = 99
+exclude = '''
+/(
+    | .eggs
+    | .git
+    | .tox
+    | .venv
+    | .build
+    | build
+    | report
+)/
+'''
+
+[tool.isort]
+profile = "black"
+skip_glob = [
+  ".eggs",
+  ".git",
+  ".tox",
+  ".venv",
+  ".build",
+  "build",
+  "report"
+]
+
+[tool.pylint]
+max-line-length = 99
+ignore = ['.eggs', '.git', '.tox', '.venv', '.build', 'report', 'tests']
+
+[tool.mypy]
+warn_unused_ignores = true
+warn_unused_configs = true
+warn_unreachable = true
+disallow_untyped_defs = true
+exclude = ['.eggs', '.git', '.tox', '.venv', '.build', 'report', 'tests']
+
+## Ignore unsupported imports
+[[tool.mypy.overrides]]
+ignore_missing_imports = true
+module = ["setuptools"]
+
+[tool.coverage.run]
+relative_files = true
+source = ["."]
+omit = ["tests/**", "docs/**", "lib/**", "snap/**", "build/**", "setup.py"]
+
+[tool.coverage.report]
+fail_under = 100
+show_missing = true
+
+[tool.coverage.html]
+directory = "tests/unit/report/html"
+
+[tool.coverage.xml]
+output = "tests/unit/report/coverage.xml"

rename.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# This is a template `rename.sh` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+snap=$(grep -E "^name:" snap/snapcraft.yaml | awk '{print $2}')
+echo "renaming ${snap}_*.snap to ${snap}.snap"
+echo -n "pwd: "
+pwd
+ls -al
+echo "Removing previous snap if it exists"
+if [[ -e "${snap}.snap" ]];
+then
+    rm "${snap}.snap"
+fi
+echo "Renaming snap here."
+mv ${snap}_*.snap ${snap}.snap

snap/snapcraft.yaml

@@ -29,6 +29,12 @@ apps:
     plugs:
       - network-bind
       - opengl
+    daemon: simple
+    install-mode: disable
+    restart-condition: on-failure
+    restart-delay: 2s
+    environment:
+      DCGM_HOME_DIR: "${SNAP_COMMON}"
   dcgmi:
     command: usr/bin/dcgmi
     plugs:

tests/functional/conftest.py

@@ -0,0 +1,27 @@
+import os
+import subprocess
+from time import sleep
+
+import pytest
+
+
+@pytest.fixture(scope="session", autouse=True)
+def install_dcgm_snap():
+    """Install the snap and enable dcgm-exporter service for testing."""
+    snap = os.environ["TEST_SNAP"]
+    dcgm_exporter_service = "snap.dcgm.dcgm-exporter.service"
+    assert 0 == subprocess.run(["sudo", "snap", "install", "--dangerous", snap]).returncode
+
+    subprocess.run(["sudo", "systemctl", "enable", "--now", dcgm_exporter_service])
+    sleep(5)  # Give some time for the service to start
+
+    assert (
+        0
+        == subprocess.run(
+            ["sudo", "systemctl", "is-active", "--quiet", dcgm_exporter_service]
+        ).returncode
+    )
+
+    yield
+
+    subprocess.run(["sudo", "snap", "remove", "--purge", "dcgm"])

tests/functional/test_snap_dcgm.py

@@ -0,0 +1,17 @@
+import subprocess
+from time import sleep
+
+
+def test_dcgm_exporter_endpoint():
+    """Smoke test of the dcgm-exporter service and its endpoint."""
+    dcgm_exporter_endpoint = "localhost:9400/metrics"
+    subprocess.run(["sudo", "snap", "disconnect", "dcgm:network-bind"])
+
+    # The Endpoint should be unavailable with the networking plug
+    assert 0 != subprocess.run(["curl", dcgm_exporter_endpoint]).returncode
+
+    subprocess.run(["sudo", "snap", "connect", "dcgm:network-bind"])
+    print("reconnect")
+    sleep(5)  # should be sufficient for the service to restart
+
+    assert 0 == subprocess.run(["curl", dcgm_exporter_endpoint]).returncode

tox.ini

@@ -0,0 +1,47 @@
+# This is a template `tox.ini` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+[tox]
+skipsdist=True
+envlist = lint, unit, func
+skip_missing_interpreters = True
+
+[testenv]
+basepython = python3
+setenv = PYTHONPATH={toxinidir}
+
+[testenv:lint]
+commands =
+    pflake8
+    pylint --recursive=y .
+    black --check --diff --color .
+    isort --check --diff --color .
+deps =
+    black
+    flake8
+    pyproject-flake8
+    flake8-docstrings
+    pep8-naming
+    flake8-colors
+    colorama
+    isort
+    pylint
+    {[testenv:func]deps}
+
+[testenv:reformat]
+envdir = {toxworkdir}/lint
+deps = {[testenv:lint]deps}
+commands =
+    black .
+    isort .
+
+[testenv:unit]
+
+[testenv:func]
+deps =
+    pytest
+passenv =
+    TEST_*
+commands =
+    pytest {toxinidir}/tests/functional {posargs:-v}