Test for sort imports

Sorting imports has been an unwritten coding style of our codebase. This
commit makes it into a test rule.

Signed-off-by: Hritik Vijay <hritikxx8@gmail.com>

Author: Hritik14

Makefile

@@ -27,6 +27,7 @@ VENV=venv
 ACTIVATE?=. ${VENV}/bin/activate;
 VIRTUALENV_PYZ=etc/thirdparty/virtualenv.pyz
 BLACK_ARGS=-l 100 .
+ISORT_ARGS=.
 # Do not depend on Python to generate the SECRET_KEY
 GET_SECRET_KEY=`base64 /dev/urandom | head -c50`
 # Customize with `$ make envfile ENV_FILE=/etc/vulnerablecode/.env`
@@ -61,14 +62,20 @@ envfile:
 	@echo SECRET_KEY=\"${GET_SECRET_KEY}\" > ${ENV_FILE}
 
 check:
+	@echo "-> Run isort validation"
+	@${ACTIVATE} isort --check-only ${ISORT_ARGS}
 	@echo "-> Run black validation"
 	@${ACTIVATE} black --check ${BLACK_ARGS}
 
 black:
 	@echo "-> Apply black code formatter"
 	${VENV}/bin/black ${BLACK_ARGS}
 
-valid: black
+isort:
+	@echo "-> Apply isort code formatter"
+	${VENV}/bin/isort ${ISORT_ARGS}
+
+valid: isort black
 
 clean:
 	@echo "-> Clean the Python env"

pyproject.toml

@@ -43,4 +43,10 @@ addopts = [
     "-rfExXw",
     "--strict",
     "--doctest-modules"
-]
+]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+force_single_line = true
+skip_gitignore = true

requirements.txt

@@ -19,3 +19,4 @@ django-environ==0.4.5
 defusedxml==0.7.1
 
 Markdown==3.3.4
+isort==5.7.0

vulnerabilities/tests/test_basics.py

@@ -20,11 +20,10 @@
 #  VulnerableCode is a free software code scanning tool from nexB Inc. and others.
 #  Visit https://github.com/nexB/vulnerablecode/ for support and download.
 
-from os.path import dirname
-from os.path import join
 import subprocess
 import sys
 import unittest
+from os.path import dirname, join
 
 root_dir = dirname(dirname(dirname(__file__)))
 bin_dir = dirname(sys.executable)
@@ -36,4 +35,16 @@ def test_codestyle(self):
         try:
             subprocess.check_output(args.split(), cwd=root_dir)
         except Exception as e:
-            raise Exception(f"Black style check failed, please format the code using black") from e
+            raise Exception(
+                "Black style check failed, please format the code using black -l 100 . "
+                "Alternatively, run ``make valid``"
+            ) from e
+
+        args = join(bin_dir, "isort --check-only .")
+        try:
+            subprocess.check_output(args.split(), cwd=root_dir)
+        except Exception as e:
+            raise Exception(
+                "Unsorted imports, please sort your imports using isort. "
+                "Alternatively, run ``make valid``"
+            ) from e