Merge branch '4-add-pytest' into 'master'

Resolve "Add pytest"

Closes #4

See merge request ShellLogger/ShellLogger!5

Author: jmgate

.coveragerc

@@ -0,0 +1,31 @@
+[run]
+omit =
+    */tests/*
+    */venv*
+branch = True
+dynamic_context = test_function
+
+[paths]
+source = shelllogger
+
+[report]
+skip_covered = False
+fail_under = 85
+show_missing = True
+exclude_lines =
+    pragma: no cover
+    if 0:
+    if False:
+
+[html]
+directory = tests/htmlcov
+title = ShellLogger Coverage Report
+show_contexts = True
+
+[xml]
+output = tests/coverage.xml
+
+[json]
+output = tests/coverage.json
+pretty_print = True
+show_contexts = True

.gitlab-ci.yml

@@ -0,0 +1,161 @@
+# This file controls the GitLab CI pipeline for the `ShellLogger`
+# project.  See here for the keyword reference:
+# https://docs.gitlab.com/ee/ci/yaml/.
+
+
+#image: alpine:latest
+
+
+#variables:
+  #HTTP_PROXY: http://wwwproxy.sandia.gov:80
+  #HTTPS_PROXY: http://wwwproxy.sandia.gov:80
+  #NO_PROXY: 127.0.0.1,localhost,.sandia.gov,/var/run/docker.sock
+
+
+# Set up a global cache to pass information across stages.
+cache: &global_cache
+  key: "${CI_COMMIT_REF_SLUG}_${CI_COMMIT_SHORT_SHA}"
+  paths:
+    - tests/htmlcov/
+    - venv-clean-python/
+  policy: pull-push
+
+
+# Set up the pipeline stages.
+stages:
+  - prepare
+  - test
+  - deploy
+  - examples
+  - documentation
+  - publish
+  - finish
+
+
+# Run this before every job.
+before_script:
+  - |-
+    export LSB_RELEASE=$(which lsb_release)
+    if [ -x ${LSB_RELEASE} ]; then
+        ${LSB_RELEASE} -a
+    fi
+  - |-
+    if [ -d "venv-clean-python" ]; then
+        source venv-clean-python/bin/activate
+    else
+        echo "Virtual Environment 'venv-clean-python' was not found"
+        exit 1
+    fi
+    echo "-----"
+    echo "VIRTUAL_ENV = ${VIRTUAL_ENV:?}"
+    echo "-----"
+
+
+# Run this after every job.
+after_script:
+  - |-
+    if [ ! -z ${VIRTUAL_ENV} ]; then
+        deactivate
+    fi
+
+
+# Create the virtual environment, install the requirements, and save the
+# environment to the cache.
+Install Requirements:
+  stage: prepare
+  timeout: 10m
+  before_script:
+    - python3 -m venv venv-clean-python
+  cache:
+    <<: *global_cache
+    when: on_success
+  script:
+    - source venv-clean-python/bin/activate
+
+    # Remove shelllogger if it's been installed.
+    - python3 -m pip uninstall -y shelllogger
+
+    # Install required packages.
+    - python3 -m pip install wheel
+      -r requirements.txt
+      -r tests/requirements.txt
+      -r doc/requirements.txt
+
+
+# Execute the unit tests.
+pytest:
+  stage: test
+  needs: ["Install Requirements"]
+  timeout: 5m
+  cache:
+    <<: *global_cache
+  script:
+    - python3 -m pytest
+      --cov=src.shelllogger
+      --cov-config=.coveragerc
+      --cov-report=html
+      --cov-report=term
+      --cov-report=xml
+      --full-trace
+      tests/
+  coverage: '/TOTAL\s*[0-9]*\s*[0-9]*\s*[0-9]*\s*[0-9]*\s*(\d+%)/'
+  artifacts:
+    reports:
+      cobertura: tests/coverage.xml
+      junit: tests/coverage.xml
+
+
+# Test building a distribution.
+Build Distribution:
+  stage: deploy
+  needs: ["Install Requirements"]
+  timeout: 5m
+  cache:
+    <<: *global_cache
+    policy: pull
+  script:
+    - python3 -m pip wheel --no-deps -w dist .
+  artifacts:
+    name: "shelllogger-dist"
+    paths:
+      - dist/shelllogger*.whl
+    expire_in: 6 weeks
+
+
+# Test installation of the package.
+Install Package:
+  stage: deploy
+  needs: ["Install Requirements"]
+  timeout: 5m
+  cache:
+    <<: *global_cache
+  script:
+    - python3 -m pip install .
+
+
+# Publish coverage data (if on the main branch).
+Pages:
+  stage: publish
+  needs: ["pytest"]
+  timeout: 5m
+  cache:
+    <<: *global_cache
+    policy: pull
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+  script:
+    - mkdir -p public
+    - mv tests/htmlcov public/.
+  artifacts:
+    paths:
+      - public
+
+
+# Test that uninstalling from a virtual environment works.
+Uninstall Package:
+  stage: finish
+  timeout: 5m
+  cache:
+    <<: *global_cache
+  script:
+    - python3 -m pip uninstall -y shelllogger

README.md

@@ -1,3 +1,6 @@
+[![pipeline status](https://internal.gitlab.server/ShellLogger/ShellLogger/badges/master/pipeline.svg)](https://internal.gitlab.server/ShellLogger/ShellLogger/pipelines)
+[![coverage report](https://internal.gitlab.server/ShellLogger/ShellLogger/badges/master/coverage.svg)](http://10.202.36.47:8080/ShellLogger/coverage/index.html)
+
 # ShellLogger
 
 FILL THIS OUT

doc/requirements.txt

@@ -0,0 +1,5 @@
+# Requirements for building the `ShellLogger` documentation.
+
+sphinx
+sphinx-argparse
+sphinx-rtd-theme

pyproject.toml

@@ -31,7 +31,7 @@ classifiers = [
     "Topic :: System :: Logging",
     "Topic :: System :: Shells",
     "Topic :: System :: System Shells",
-    # "Typing :: Typed"  UNCOMMENT AFTER ADDING TYPE HINTS
+    "Typing :: Typed"
 ]
 packages = [
     { include = "shelllogger", from = "src" },

requirements.txt

@@ -0,0 +1 @@
+# Main requirements for `ShellLogger`.

tests/requirements.txt

@@ -0,0 +1,7 @@
+# Requirements for testing `ShellLogger`.
+
+mock >= 4
+psutil
+pytest >= 6.2
+pytest-cov >= 2.12
+pytest-mock >= 3.6

tests/test_ShellLogger.py

@@ -4,10 +4,13 @@
 import json
 import os
 from pathlib import Path
-import psutil
 import pytest
 import re
 from src.shelllogger import ShellLogger, ShellLoggerDecoder
+try:
+    import psutil
+except ModuleNotFoundError:
+    psutil = None
 
 
 @pytest.fixture(autouse=True)
@@ -412,6 +415,7 @@ def test_syntax_error() -> None:
     assert "There was a problem running the command" in excinfo.value.args[0]
 
 
+@pytest.mark.skipif(psutil is None, reason="`psutil` is unavailable")
 def test_logger_does_not_store_stdout_string_by_default() -> None:
     """
     Ensure we don't hold a commands ``stdout`` in memory by default.
@@ -640,12 +644,12 @@ def test_trace_and_stats() -> None:
                              expression="setlocale", summary=True)
         assert "setlocale" in result.trace
         assert "sleep" not in result.trace
-        assert len(result.stats["memory"]) > 8
-        assert len(result.stats["memory"]) < 30
-        assert len(result.stats["cpu"]) > 8
-        assert len(result.stats["cpu"]) < 30
-        assert len(result.stats["disk"]["/"]) > 8
-        assert len(result.stats["disk"]["/"]) < 30
+        assert len(result.stats["memory"]) > 5
+        assert len(result.stats["memory"]) < 50
+        assert len(result.stats["cpu"]) > 5
+        assert len(result.stats["cpu"]) < 50
+        assert len(result.stats["disk"]["/"]) > 5
+        assert len(result.stats["disk"]["/"]) < 50
     else:
         print(f"Warning: uname is not 'Linux': {os.uname()}; ltrace not "
               "tested.")
@@ -697,12 +701,12 @@ def test_log_book_trace_and_stats() -> None:
                    trace="ltrace", expression="setlocale", summary=True)
         assert "setlocale" in logger.log_book[0]["trace"]
         assert "sleep" not in logger.log_book[0]["trace"]
-        assert len(logger.log_book[0]["stats"]["memory"]) > 8
-        assert len(logger.log_book[0]["stats"]["memory"]) < 30
-        assert len(logger.log_book[0]["stats"]["cpu"]) > 8
-        assert len(logger.log_book[0]["stats"]["cpu"]) < 30
-        assert len(logger.log_book[0]["stats"]["disk"]["/"]) > 8
-        assert len(logger.log_book[0]["stats"]["disk"]["/"]) < 30
+        assert len(logger.log_book[0]["stats"]["memory"]) > 5
+        assert len(logger.log_book[0]["stats"]["memory"]) < 50
+        assert len(logger.log_book[0]["stats"]["cpu"]) > 5
+        assert len(logger.log_book[0]["stats"]["cpu"]) < 50
+        assert len(logger.log_book[0]["stats"]["disk"]["/"]) > 5
+        assert len(logger.log_book[0]["stats"]["disk"]["/"]) < 50
     else:
         print(f"Warning: uname is not 'Linux': {os.uname()}; ltrace not "
               "tested.")