Merge pull request #2656 from VOLTTRON/releases/8.x

Releases/8.x

.github/workflows/build-dependency-cache.yml

@@ -0,0 +1,65 @@
+---
+# Creates a cache of the env directory
+# Documentation for the syntax of this file is located
+# https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
+
+# The workflow name will show up in the action tab on github during execution
+# https://github.com/VOLTTRON/volttron/actions (or if you are pushing to your own fork change the user)
+
+name: cache virtual env
+
+# Check the cache when a push happens to the repository.
+on: [push]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-16.04, ubuntu-18.04, ubuntu-20.04]
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+      # checkout the volttron repository and set current direectory to it
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{matrix.os}} ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - id: envcache
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-env
+        with:
+          # This path is specific to Ubuntu
+          path: ./env
+          # Look to see if there is a cache hit for the corresponding requirements file
+          key: env-${{ matrix.os }}-${{matrix.python-version}}-${{hashFiles('requirements.py')}}
+          #-${{hashFiles('requirements.py')}}
+          #  env-${{ matrix.os }}-${{matrix.python-version}}
+
+          restore-keys: |
+            env-${{ matrix.os }}-${{matrix.python-version}}-${{hashFiles('requirements.py')}}
+            env-${{ matrix.os }}-${{matrix.python-version}}
+      
+      - name: Check env existance
+        id: check_files
+        uses: andstor/file-existence-action@v1
+        with:
+          files: "env/bin/activate"
+
+      - name: Install dependencies
+        if: steps.check_files.outputs.files_exists != 'true'
+        run: |
+          pip install wheel
+          python bootstrap.py --all --force
+
+# Only works on default branch of the target repo
+#       - name: Repository Dispatch
+#         uses: peter-evans/repository-dispatch@v1
+#         with:
+#           token: ${{ secrets.WORKFLOW_ACCESS_TOKEN }}
+#           repository: ${{ github.repository }}
+#           event-type: my-event
+#           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

.github/workflows/pytest-auth.yml

@@ -0,0 +1,100 @@
+---
+# This workflow is meant as a foundational workflow for running integration/unit tests on multiple targeted
+# ubuntu versions with multiple python versions.
+#
+# This workflow utilizes the build-dependency-cache workflow which sets up the environment dependencies using
+# bootstrap.py --all
+#
+
+# Documentation for the syntax of this file is located
+# https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
+
+# The workflow name will show up in the action tab on github during execution
+# https://github.com/VOLTTRON/volttron/actions (or if you are pushing to your own fork change the user)
+name: Testing platform auth
+
+# Determine what events are going to trigger a running of the workflow
+on: [push, pull_request]
+
+jobs:
+  # The job named build
+  build:
+    # The strategy allows customization of the build and allows matrixing the version of os and software
+    # https://docs.github.com/en/free-pro-team@l.atest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategy
+    strategy:
+      fail-fast: false
+      matrix:
+        # Each entry in the os and python-version matrix will be run so for the 3 x 4 there will be 12 jobs run
+        os: [ ubuntu-16.04, ubuntu-18.04, ubuntu-20.04 ]
+        python-version: [ 3.6, 3.7] # , 3.8, 3.9 ]
+
+    # Run-on determines the operating system available to run on
+    # - At the current time there is only ubuntu machines between 16.04 and 20.04 available
+    # - This uses the matrix os from the strategy above
+    runs-on: ${{ matrix.os }}
+
+    # Each step will be run in order of listing.
+    steps:
+      # checkout the volttron repository and set current direectory to it
+      - uses: actions/checkout@v2
+
+      # setup the python environment for the operating system
+      - name: Set up Python ${{matrix.os}} ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Attempt to restore the cache from the build-dependency-cache workflow if present then
+      # the output value steps.check_files.outputs.files_exists will be set (see the next step for usage)
+      - name: Has restored cache
+        id: check_files
+        uses: andstor/file-existence-action@v1
+        with:
+          files: "env/bin/activate"
+
+      # This step is only run if the cache wasn't able to be restored.
+      - name: Install dependencies
+        if: steps.check_files.outputs.files_exists != 'true'
+        run: |
+          pip install wheel
+          python bootstrap.py --all  --force
+
+      - name: Install volttron
+        run: |
+          source env/bin/activate
+          pip install -e .
+
+      # Run the specified tests and save the results to a unique file that can be archived for later analysis.
+      - name: Run pytest
+        run: |
+          source env/bin/activate
+          pip install -e .
+          pytest volttrontesting/platform/auth_tests -rf -o junit_family=xunit2 --junitxml=output/test-auth-${{matrix.os}}-${{ matrix.python-version }}-results.xml
+
+      # Archive the results from the pytest to storage.
+      - name: Archive test results
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: pytest-report
+          path: output/test-auth-${{matrix.os}}-${{ matrix.python-version }}-results.xml
+
+#       - name: Publish Unit Test Results
+#         uses: EnricoMi/publish-unit-test-result-action@v1.5
+#         if: always()
+#         with:
+#           github_token: ${{ secrets.WORKFLOW_ACCESS_TOKEN }}
+#           files: output/test-testutils*.xml
+
+
+#-cov=com --cov-report=xml --cov-report=html
+# pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+#    - name: Lint with flake8
+#      run: |
+#        # stop the build if there are Python syntax errors or undefined names
+#        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+#        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+#        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+#    - name: Test with pytest
+#      run: |
+#        pytest --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html

.github/workflows/pytest-testutils.yml

@@ -0,0 +1,89 @@
+---
+# This workflow is meant as a foundational workflow for running integration/unit tests on the
+# plaform.  For this workflow we are testing the
+#
+# volttrontesting/testutils directory using pytest.
+#
+# This workflow also shows the caching mechanisms available for storage
+# and retrieval of cache for quicker setup of test environments.
+
+name: Testing testutils directory
+on: [push, pull_request]
+
+jobs:
+  build:
+    # The strategy allows customization of the build and allows matrixing the version of os and software
+    # https://docs.github.com/en/free-pro-team@l.atest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategy
+    strategy:
+      fail-fast: false
+      matrix:
+        # Each entry in the os and python-version matrix will be run so for the 3 x 4 there will be 12 jobs run
+        os: [ ubuntu-16.04, ubuntu-18.04, ubuntu-20.04 ]
+        python-version: [ 3.6, 3.7] # , 3.8, 3.9 ]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      # checkout the volttron repository and set current direectory to it
+      - uses: actions/checkout@v2
+
+      # Attempt to restore the cache from the build-dependency-cache workflow if present then
+      # the output value steps.check_files.outputs.files_exists will be set (see the next step for usage)
+      - name: Set up Python ${{matrix.os}} ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Determine if the cache was restored or not.
+      - name: Has restored cache
+        id: check_files
+        uses: andstor/file-existence-action@v1
+        with:
+          files: "env/bin/activate"
+
+      # if cache wasn't restored then do an installation of the dependencies
+      - name: Install dependencies
+        if: steps.check_files.outputs.files_exists != 'true'
+        run: |
+          pip install wheel
+          python bootstrap.py --all  --force
+            
+      - name: Install volttron
+        run: |
+          source env/bin/activate
+          pip install -e .
+
+      # Run the specified tests and save the results to a unique file that can be archived for later analysis.
+      - name: Run pytest
+        run: |
+          source env/bin/activate
+          pip install -e .
+          pytest volttrontesting/testutils -rf -o junit_family=xunit2 --junitxml=output/test-testutils-${{matrix.os}}-${{ matrix.python-version }}-results.xml
+
+      # Archive the results from the pytest to storage.
+      - name: Archive test results
+        uses: actions/upload-artifact@v2
+        if: always()
+        with:
+          name: pytest-report
+          path: output/test-testutils-${{matrix.os}}-${{ matrix.python-version }}-results.xml
+
+#       - name: Publish Unit Test Results
+#         uses: EnricoMi/publish-unit-test-result-action@v1.5
+#         if: always()
+#         with:
+#           github_token: ${{ secrets.WORKFLOW_ACCESS_TOKEN }}
+#           files: output/test-testutils*.xml
+
+
+#-cov=com --cov-report=xml --cov-report=html
+# pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+#    - name: Lint with flake8
+#      run: |
+#        # stop the build if there are Python syntax errors or undefined names
+#        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+#        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+#        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+#    - name: Test with pytest
+#      run: |
+#        pytest --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html

.gitignore

@@ -20,7 +20,7 @@ applications
 /configs/
 /config/
 /docs/build/*
-/docs/source/volttron_api
+/docs/source/volttron-api
 volttron.log
 __pycache__
 .python-version
@@ -33,3 +33,5 @@ rabbitmq.log
 htmlcov/
 MnesiaCore.*
 rabbitmq-server.download.tar.xz
+/MagicMock/mock/
+/docs/source/volttron_api/

.travis.yml

@@ -9,6 +9,3 @@ services:
 
 script: ci-integration/run-test-docker.sh
 
-notifications:
-  slack: volttron-team:EgnBsUcQ98b75kU59tV8TnEa
-

CONTRIBUTING.md

@@ -6,7 +6,7 @@ We have a lengthy [Guide to Contributions](https://volttron.readthedocs.io/en/de
 
 ### Branch Naming
 
-We use `develop` as the active development branch, and not `master`. Please submit PRs to `develop` by default.
+We use `develop` as the active development branch, and not `main`. Please submit PRs to `develop` by default.
 
 ### Testing
 

COPYRIGHT

@@ -1,4 +1,4 @@
-# Copyright (c) 2019, Battelle Memorial Institute
+# Copyright 2020, Battelle Memorial Institute.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without