Merge pull request #227 from sommersoft/testing

Add Some Basic Tests

Author: kattni

.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: Test Adabot
+
+on: [push, pull_request]
+
+jobs:
+  check-repo-owner:
+    # This job is so the entire workflow will end successfully and give some
+    # output to explain why it hasn't run on a non-Adafruit fork.
+    runs-on: ubuntu-latest
+    steps:
+      - name: repository
+        env:
+          OWNER_IS_ADAFRUIT: ${{ startswith(github.repository, 'adafruit/') }}
+        run: |
+          echo "This workflow will only run if Adafruit is the repository owner."
+          echo "Repository owner is Adafruit: $OWNER_IS_ADAFRUIT"
+  run-tests:
+    runs-on: ubuntu-latest
+    # Only run the build on Adafruit's repository. Forks won't have the secrets.
+    # Its necessary to do this here, since 'schedule' events cannot (currently)
+    # be limited (they run on all forks' default branches).
+    if: startswith(github.repository, 'adafruit/')
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379/tcp
+        options: --entrypoint redis-server
+    steps:
+    - name: Dump GitHub context
+      env:
+        GITHUB_CONTEXT: ${{ toJson(github) }}
+      run: echo "$GITHUB_CONTEXT"
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: Versions
+      run: |
+        python3 --version
+    - uses: actions/checkout@v1
+      with:
+        submodules: true
+    - name: Install deps
+      run: |
+        pip install -r requirements.txt
+    - name: Run Tests
+      env:
+        ADABOT_EMAIL: ${{ secrets.ADABOT_EMAIL }}
+        ADABOT_GITHUB_USER: ${{ secrets.ADABOT_GITHUB_USER }}
+        ADABOT_GITHUB_ACCESS_TOKEN: ${{ secrets.ADABOT_GITHUB_ACCESS_TOKEN }}
+        REDIS_PORT: ${{ job.services.redis.ports[6379] }}
+      run: |
+        python3 -u -m pytest

.gitignore

@@ -8,3 +8,4 @@ env.sh
 .libraries/*
 .cp_org/*
 .blinka/*
+.vscode

adabot/__init__.py

@@ -236,11 +236,8 @@ def run_arduino_lib_checks():
         print_list_output("Libraries that is missing library.properties file: ({})", missing_library_properties_list)
 
 
-if __name__ == "__main__":
-    cmd_line_args = cmd_line_parser.parse_args()
-    verbosity = cmd_line_args.verbose
-    if cmd_line_args.output_file:
-        output_filename = cmd_line_args.output_file
+def main(verbosity=1, output_filename=None):
+
     try:
         reply = requests.get("http://downloads.arduino.cc/libraries/library_index.json")
         if not reply.ok:
@@ -268,3 +265,11 @@ def run_arduino_lib_checks():
             with open(output_filename, 'w') as f:
                 for line in file_data:
                     f.write(str(line) + "\n")
+
+if __name__ == "__main__":
+    cmd_line_args = cmd_line_parser.parse_args()
+    main(
+        verbosity=cmd_line_args.verbose,
+        output_filename=cmd_line_args.output_file
+    )
+

adabot/arduino_libraries.py

@@ -109,7 +109,7 @@
     'Adafruit_Python_Extended_Bus'
 ]
 
-def run_library_checks(validators, bundle_submodules, latest_pylint, kw_args):
+def run_library_checks(validators, bundle_submodules, latest_pylint, kw_args, error_depth):
     """runs the various library checking functions"""
     pylint_info = pypi.get("/pypi/pylint/json")
     if pylint_info and pylint_info.ok:
@@ -491,29 +491,24 @@ def print_issue_overview(*insights):
             )
         output_handler(hacktober_changes)
 
-if __name__ == "__main__":
+def main(verbosity=1, output_filename=None, validator=None, error_depth=5):
     validator_kwarg_list = {}
     startup_message = [
         "Running CircuitPython Library checks...",
         "Report Date: {}".format(datetime.datetime.now().strftime("%d %B %Y, %I:%M%p"))
     ]
-    cmd_line_args = cmd_line_parser.parse_args()
-
-    verbosity = cmd_line_args.verbose
 
-    if cmd_line_args.output_file:
-        output_filename = cmd_line_args.output_file
+    if output_filename:
         startup_message.append(" - Report output will be saved to: {}".format(output_filename))
 
     validators = []
     validator_names = []
-    if cmd_line_args.validator:
-        error_depth = cmd_line_args.error_depth
+    if validator:
         startup_message.append(" - Depth for listing libraries with errors: {}".format(error_depth))
 
-        if cmd_line_args.validator != "all":
+        if validator != "all":
             validators = []
-            for func in cmd_line_args.validator.split(","):
+            for func in validator.split(","):
                 func_name = func.strip()
                 try:
                     if not func_name.startswith("validate"):
@@ -553,7 +548,7 @@ def print_issue_overview(*insights):
         output_handler()
         #print(validators)
         run_library_checks(validators, bundle_submodules, latest_pylint,
-                           validator_kwarg_list)
+                           validator_kwarg_list, error_depth)
     except:
         if output_filename is not None:
             exc_type, exc_val, exc_tb = sys.exc_info()
@@ -572,3 +567,12 @@ def print_issue_overview(*insights):
             with open(output_filename, 'w') as f:
                 for line in file_data:
                     f.write(str(line) + "\n")
+
+if __name__ == "__main__":
+    cli_args = cmd_line_parser.parse_args()
+    main(
+        verbosity=cli_args.verbose,
+        output_filename=cli_args.output_file,
+        validator=cli_args.validator,
+        error_depth=cli_args.error_depth
+    )

adabot/circuitpython_libraries.py

@@ -0,0 +1,3 @@
+[pytest]
+addopts = -v --tb=short --show-capture=no
+testpaths = tests/unit/ tests/integration/

pytest.ini

@@ -3,6 +3,7 @@ chardet==3.0.4
 idna==2.6
 packaging==20.3
 pylint
+pytest
 pyyaml==5.4.1
 redis==2.10.6
 requests==2.20.0

requirements.txt

@@ -0,0 +1,17 @@
+import pytest
+
+from adabot import arduino_libraries
+from adabot import github_requests
+
+def test_adafruit_libraries(monkeypatch):
+
+    def get_list_repos():
+        repos = []
+        repos.append(github_requests.get("/repos/adafruit/Adafruit_NeoPixel").json())
+        return repos
+
+    monkeypatch.setattr(arduino_libraries, "list_repos", get_list_repos)
+
+    print(arduino_libraries.list_repos())
+
+    arduino_libraries.main()

tests/integration/test_arduino_libraries.py

@@ -0,0 +1,16 @@
+import pytest
+
+from adabot.lib import common_funcs
+from adabot import github_requests
+from adabot import circuitpython_libraries
+
+def test_circuitpython_libraires(monkeypatch):
+    
+    def mock_list_repos(*args, **kwargs):
+        repos = []
+        repos.append(github_requests.get("/repos/adafruit/Adafruit_CircuitPython_TestRepo").json())
+        return repos
+    
+    monkeypatch.setattr(common_funcs, "list_repos", mock_list_repos)
+
+    circuitpython_libraries.main(validator="all")

tests/integration/test_circuitpython_libraries.py

@@ -0,0 +1,6 @@
+import pytest
+
+from adabot.lib import blinka_funcs
+
+def test_board_count():
+    assert blinka_funcs.board_count() >= 0

tests/test_circuitpython_libraries.py

@@ -0,0 +1,10 @@
+import pytest
+from adabot.lib import common_funcs
+
+def test_list_repos():
+    repos = common_funcs.list_repos()
+
+    assert isinstance(repos, list)
+
+def test_repo_is_on_pypi_true():
+    assert common_funcs.repo_is_on_pypi({"name": "pytest"})

tests/unit/test_blinka_funcs.py

@@ -0,0 +1,13 @@
+import pytest
+
+from adabot import github_requests
+
+def test_fix_url():
+    url = github_requests._fix_url("/meta")
+    assert  url == "https://api.github.com/meta"
+
+def test_fix_kwargs():
+    dummy_kwargs = github_requests._fix_kwargs({})
+
+    assert "headers" in dummy_kwargs
+    assert "Accept" in dummy_kwargs["headers"]

tests/unit/test_common_funcs.py

@@ -0,0 +1,7 @@
+import pytest
+
+from adabot import pypi_requests
+
+def test_fix_url():
+    url = pypi_requests._fix_url("/test")
+    assert url == "https://pypi.org/test"