Makefile changes/pipenv usage

Author: remingtonc

Makefile

@@ -1,24 +1,59 @@
 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/
-
-.PHONY: create-env
-create-env:
-	python3 -m venv env || python -m venv env
-	echo "Run => 'source env/bin/activate' "
-
-.PHONY: install
-install:
-	pip install --upgrade pip
-	pip install .
+	rm -rf .coverage build/ dist/
 
+## Runs tests.
 .PHONY: test
 test: clean
-	pytest $(TEST_DIR) -v -s --disable-warnings
+	pipenv run pytest $(TEST_DIR) -v -s --disable-warnings
+
+## Creates coverage report.
+.PHONY: coverage
+coverage:
+	pipenv run pytest --cov=src/ --cov-report=term-missing --disable-warnings
+
+.DEFAULT:
+	@$(MAKE) help
+
+## This help message.
+.PHONY: help
+help:
+	@printf "\nUsage:\n";
 
-.PHONY: open-report
-open-report:
-	pytest --cov=src/ --cov-report=term-missing --cov-report=html --disable-warnings
-	open htmlcov/index.html || xdg-open htmlcov/index.html
+	@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

@@ -144,11 +144,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
 ```
 

tests/README.md

@@ -1,20 +1,16 @@
 # Tests
 
-> You should've cloned this project/repo, if not run the below command in your terminal:
+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
 
-- Create a virtual environment 
+- Setup the developer virtual environment
 ```
-make create-env
-```
-
-- Install tests requirements
-```
-make install
+make setup
 ```
 
 ## Usage
@@ -28,5 +24,5 @@ make test
 ### How to open test coverage
 
 ```
-make open-report
+make coverage
 ```