Merge pull request #20 from Physsix27/master

Adding  Makefile, docs and Tests for util.py & auth.py

Author: remingtonc

Makefile

@@ -0,0 +1,60 @@
+TEST_DIR=tests
+
+## Sets up the virtual environment via pipenv.
+.PHONY: setup
+setup:
+	pipenv --three install --dev
+
+## Cleans test and packaging outputs.
+.PHONY: clean
+clean:
+	rm -rf .coverage htmlcov/ build/ dist/
+
+## Runs tests.
+.PHONY: test
+test: clean
+	pipenv run pytest $(TEST_DIR) -v -s --disable-warnings
+
+## Creates coverage report.
+.PHONY: coverage
+coverage:
+	pytest --cov=src/ --cov-report=term-missing --cov-report=html --disable-warnings
+	open htmlcov/index.html || xdg-open htmlcov/index.html
+
+.DEFAULT:
+	@$(MAKE) help
+
+## This help message.
+.PHONY: help
+help:
+	@printf "\nUsage:\n";
+
+	@awk '{ \
+			if ($$0 ~ /^.PHONY: [a-zA-Z\-\_0-9]+$$/) { \
+				helpCommand = substr($$0, index($$0, ":") + 2); \
+				if (helpMessage) { \
+					printf "\033[36m%-20s\033[0m %s\n", \
+						helpCommand, helpMessage; \
+					helpMessage = ""; \
+				} \
+			} else if ($$0 ~ /^[a-zA-Z\-\_0-9.]+:/) { \
+				helpCommand = substr($$0, 0, index($$0, ":")); \
+				if (helpMessage) { \
+					printf "\033[36m%-20s\033[0m %s\n", \
+						helpCommand, helpMessage; \
+					helpMessage = ""; \
+				} \
+			} else if ($$0 ~ /^##/) { \
+				if (helpMessage) { \
+					helpMessage = helpMessage"\n                     "substr($$0, 3); \
+				} else { \
+					helpMessage = substr($$0, 3); \
+				} \
+			} else { \
+				if (helpMessage) { \
+					print "\n                     "helpMessage"\n" \
+				} \
+				helpMessage = ""; \
+			} \
+		}' \
+		$(MAKEFILE_LIST)

Pipfile

@@ -16,6 +16,10 @@ grpcio = "*"
 protobuf = "*"
 six = "*"
 cryptography = "*"
+pytest = "*"
+pytest-cov = "*"
+pytest-mock = "*"
+pytest-coverage = "*"
 
 [requires]
 python_version = "3.6"

README.md

@@ -154,11 +154,13 @@ git clone https://github.com/cisco-ie/cisco-gnmi-python.git
 cd cisco-gnmi-python
 # If pipenv not installed, install!
 pip install --user pipenv
-# Now use pipenv
+# Now use Makefile...
+make setup
+# Or pipenv manually if make not present
 pipenv --three install --dev
 # Enter virtual environment
 pipenv shell
-# Do your thing.
+# Work work
 exit
 ```
 

hygiene.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 # Script which autoformats (black) and lints (pylint) code
 echo "Running black ..."
-FORMAT_COMMAND="black --safe --verbose --exclude proto src/cisco_gnmi"
+FORMAT_COMMAND="black --safe --verbose --exclude proto src/cisco_gnmi tests/"
 if black &> /dev/null; then
     eval $FORMAT_COMMAND
 elif pipenv run black &> /dev/null; then

requirements.txt

@@ -9,3 +9,7 @@ ipaddress==1.0.22 ; python_version < '3'
 protobuf==3.9.2
 pycparser==2.19
 six==1.12.0
+pytest==5.2.1
+pytest-cov==2.8.1
+pytest-mock==1.11.1
+coverage==4.5.4

setup.py

@@ -63,6 +63,10 @@
             "twine",
             "setuptools",
             "wheel",
+            "pytest",
+            "pytest-cov",
+            "pytest-mock",
+            "coverage",
         ],
     },
 )

tests/README.md

@@ -0,0 +1,28 @@
+# Tests
+
+Clone the project and enter the project directory:
+```
+git clone git@github.com:cisco-ie/cisco-gnmi-python.git
+cd cisco-gnmi-python
+```
+
+## Pre-requisite
+
+- Setup the developer virtual environment
+```
+make setup
+```
+
+## Usage
+
+### How to run tests
+
+```
+make test
+```
+
+### How to open test coverage
+
+```
+make coverage
+```

tests/__init__.py

@@ -0,0 +1,16 @@
+import unittest
+from unittest import mock
+from src.cisco_gnmi.auth import CiscoAuthPlugin
+
+
+def test_call():
+    username = "grpc-username"
+    password = "grpc-password"
+
+    mock_call = mock.MagicMock(spec=CiscoAuthPlugin.__call__)
+
+    instance = CiscoAuthPlugin(username, password)
+    result = instance.__call__(
+        [(username, "testUsr"), (password, "testPass")], CiscoAuthPlugin
+    )
+    mock_call.assert_not_called()

tests/test_auth.py

@@ -0,0 +1,111 @@
+import pytest
+from pytest_mock import mocker
+from src.cisco_gnmi.proto import gnmi_pb2
+from src.cisco_gnmi import util
+from src.cisco_gnmi.util import urlparse, ssl, x509, default_backend
+
+
+def test_gen_target_netloc_valueerror():
+    with pytest.raises(ValueError):
+        util.gen_target_netloc("http://www.test.com", "test_prefix://", 8000)
+
+
+def test_gen_target_netloc_parsed_none():
+
+    mock_netloc = "//www.testing.com:8080"
+    mock_parsed_netloc = urlparse(mock_netloc)
+
+    result = util.gen_target_netloc("www.testing.com", "http://", 8080)
+    assert mock_parsed_netloc == result
+
+
+def test_validate_proto_enum_exception_one():
+
+    enum = gnmi_pb2.SubscriptionMode
+
+    with pytest.raises(Exception):
+        util.validate_proto_enum("test", "INVALID_VALUE", "test", enum)
+
+
+def test_validate_proto_enum_exception_two():
+
+    enum = gnmi_pb2.SubscriptionMode
+    fake_subset = [3]
+
+    with pytest.raises(Exception):
+        util.validate_proto_enum("test", 2, "test", enum, subset=fake_subset)
+
+
+def test_validate_proto_enum_exception_three():
+
+    enum = gnmi_pb2.SubscriptionMode
+    fake_subset = ["ON_CHANGE", "SAMPLE"]
+
+    with pytest.raises(Exception):
+        util.validate_proto_enum(
+            "test", "TARGET_DEFINED", "test", enum, subset=fake_subset
+        )
+
+
+def test_validate_proto_enum_element_in_subset_one():
+
+    enum = gnmi_pb2.SubscriptionMode
+    fake_subset = ["ON_CHANGE", "SAMPLE"]
+
+    result = util.validate_proto_enum("test", 2, "test", enum, subset=fake_subset)
+    assert 2 == result
+
+
+def test_validate_proto_enum_element_in_subset_two():
+
+    enum = gnmi_pb2.SubscriptionMode
+    fake_subset = [2, 0]
+
+    result = util.validate_proto_enum(
+        "test", "TARGET_DEFINED", "test", enum, subset=fake_subset
+    )
+    assert 0 == result
+
+
+def test_validate_proto_enum_value_returned_one():
+
+    enum = gnmi_pb2.SubscriptionMode
+
+    result = util.validate_proto_enum("test", "ON_CHANGE", "test", enum)
+    assert 1 == result
+
+
+def test_validate_proto_enum_value_returned_two():
+
+    enum = gnmi_pb2.SubscriptionMode
+
+    result = util.validate_proto_enum("test", 1, "test", enum)
+    assert 1 == result
+
+
+def test_get_cert_from_target():
+
+    target_netloc = {"hostname": "cisco.com", "port": 443}
+
+    expected_ssl_cert = ssl.get_server_certificate(
+        (target_netloc.get("hostname"), target_netloc.get("port"))
+    )
+
+    expected_ssl_cert.encode("utf-8")
+
+    target = util.gen_target_netloc("cisco.com:443")
+    result = util.get_cert_from_target((target)).decode("utf-8")
+
+    assert expected_ssl_cert == result
+
+
+def test_get_cn_from_cert_returned_value_invalid_entry(mocker):
+
+    mock_cert_parsed = mocker.patch.object(x509, "load_pem_x509_certificate")
+    result = util.get_cn_from_cert("INVALID_ENTRY")
+
+    assert None == result
+
+
+def test_get_cn_from_cert_returned_value(mocker):
+    pass