Merge pull request #110 from BuildingSync/develop

Prep release 1.1.3

Author: nllong

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        tox_env: [python, flake8]
+    services:
+      postgres:
+        image: postgres:9.6
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: bsync_validator
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v2
+      -
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.6'
+      -
+        name: Display system info
+        run: python -c "import sys; print(sys.version)"
+      -
+        name: Setup Python
+        run: |
+          apt-get update && apt-get install python-enchant -y
+          pip install tox
+          pip install --upgrade pip
+          pip install tox coveralls
+      -
+        name: Run tox
+        env:
+          DJANGO_SETTINGS_MODULE: bsyncviewer.settings.gh_actions
+        run: tox -e ${{ matrix.tox_env }}
+      -
+        name: Coveralls
+        if: ${{ success() && matrix.tox_env == 'python' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: coveralls --service=github

.gitignore

@@ -94,7 +94,6 @@ use_case_file_*
 mapping_template*
 template_*
 bedes-mappings-*.csv
-bsyncviewer/lib/bedes/v2.2/schema0.0.1/
 bsyncviewer/lib/bedes/*/schema*/bedes-mappings-enumerations.csv
 bsyncviewer/lib/bedes/*/schema*/bedes-mappings-terms.csv
 bsyncviewer/lib/bedes/*/schema*/bsync_unique_words.csv

.travis.yml

@@ -1,5 +1,20 @@
 # BuildingSync Use Case Selection Tool
 
+## Version 1.1.3
+
+Date Range: 06/03/20 - 06/15/21
+
+Updates:
+
+- Renamed master to main
+- Install testsuite from PyPi
+- Bump lxml to 4.6.2
+- BSync version 2.3.0 with updated example files
+- Django 2.2.20
+- Backup Script
+- Add L200 audit example file
+- Accept Zip of BuildingSync files for validation
+
 ## Version 1.1.2
 
 Date Range: 03/26/20 - 06/02/20

CHANGELOG.md

@@ -1,6 +1,6 @@
 # BuildingSync Schema Viewer and Validator
 
-[![Build Status](https://travis-ci.org/BuildingSync/selection-tool.svg?branch=develop)](https://travis-ci.org/BuildingSync/selection-tool)
+[![Build Status](https://github.com/BuildingSync/selection-tool/workflows/CI/badge.svg)](https://github.com/BuildingSync/selection-tool)
 
 This is the repository for the BuildingSync Validator web application.
 
@@ -11,7 +11,7 @@ This is the repository for the BuildingSync Validator web application.
     ```bash
     pyenv install 3.6.5
     pyenv virtualenv 3.6.5 bsync-validator-3.6.5
-    pyenv local bsync-validator-3.6.3
+    pyenv local bsync-validator-3.6.5
     ```
 1. Install PostgreSQL server for local development (if desired)
 	* Once installed, create your local database and user:
@@ -53,6 +53,8 @@ This is the repository for the BuildingSync Validator web application.
 	python manage.py reset_schema --schema_version=1.0.0
 	```
 
+**NOTE**: You will need to be off the NREL VPN to import a schema, otherwise you'll get an error related to http://www.gbxml.org/schema}Area' as the gbxml schema cannot be imported when on the NREL VPN.
+
 ### Precommit
 
 This project used `pre-commit <https://pre-commit.com/>`_ to ensure code consistency. To enable pre-commit, run the following from the command line.
@@ -96,7 +98,7 @@ tox -e flake8
 
 The BuildingSync Schema Viewer can support multiple versions of the BuildingSync schema.  Admin users can manage schemas from the Django Administration console.  Click on the 'Admin' link in the top navigation bar to access the Django Administration pages.
 
-To add a schema, specify the name, version, and schema file (XSD) to parse and save the record.  The schema file will be parsed automatically.
+To add a schema, specify the name, version, and schema file (XSD) to parse and save the record.  The schema file will be parsed automatically.  **NOTE**: You will need to be off the NREL VPN to import a schema, otherwise you'll get an error related to http://www.gbxml.org/schema}Area' as the gbxml schema cannot be imported when on the NREL VPN.
 
 To modify an existing schema, click on the edit link.  If changes are made to the uploaded XSD schema file and re-uploaded, ensure that the 'schema parsed' checkbox is unchecked before saving the record.  This will trigger the automatic schema parsing.
 
@@ -285,9 +287,9 @@ Follow these steps to add new example tables from the TestSuite repo
 
 ### Adding an OpenStudio Simulation Use Case from the TestSuite repo
 
-1. The relevant files are currently on the L000_Schematron branch of the [TestSuite](https://github.com/BuildingSync/TestSuite/tree/L100_Schematron) repo.  Clone the repo locally.
-1. OpenStudio Simulation use case schematron files include patterns from a [library of schematron files](https://github.com/BuildingSync/TestSuite/tree/L100_Schematron/lib).  Copy these files from the TestSuite repo into the selection-tool at the following location: ```bsyncviewer/testsuitelib```.
-1. Open the relevant use case file from the TestSuite repo.  For example: [L00_OpenStudio_Simulation.sch](https://github.com/BuildingSync/TestSuite/blob/L100_Schematron/spec/use_cases/schema2.0.0/L000_OpenStudio_Simulation.sch).  Edit the include statements at the top of the file with relative paths to the selection-tool testsuitelib directory.  Save the file.
+1. The relevant files are currently on the `develop` branch of the [TestSuite](https://github.com/BuildingSync/TestSuite/tree/develop) repo.  Clone the repo locally.
+1. OpenStudio Simulation use case schematron files include patterns from a [library of schematron files](https://github.com/BuildingSync/TestSuite/tree/develop/lib).  Copy these files from the TestSuite repo into the selection-tool at the following location: ```bsyncviewer/testsuitelib```.
+1. Open the relevant use case file from the TestSuite repo.  For example: [L00_OpenStudio_Simulation.sch](https://github.com/BuildingSync/TestSuite/blob/develop/schematron/v2.2.0/v2-2-0_L000_OpenStudio_Simulation.sch).  Edit the include statements at the top of the file with relative paths to the selection-tool testsuitelib directory.  Save the file.
     ```bash
       <include href="../../testsuitelib/rootElements.sch#root.oneOfEachUntilBuilding"/>
       <include href="../../testsuitelib/rootElements.sch#root.oneOfEachFacilityUntilScenario"/>
@@ -303,5 +305,5 @@ Follow these steps to add new example tables from the TestSuite repo
     1. Upload the file that was modified in the previous step
     1. Save
 1. Make the use case public from the selection-tool admin interface.
-1. If you have any example files to add to the selection-tool (for example, for the L000 OpenStudio Simulation use case, there are [2 examples files](https://github.com/BuildingSync/TestSuite/tree/L100_Schematron/spec/use_cases/schema2.0.0/examples)), add them in the appropriate schema directory in ```bsyncviewer/lib/validator/examples```. Regenerate the ```example_files.zip``` archive.  This will make the files available as examples at the ```/validator``` URL.
+1. If you have any example files to add to the selection-tool (for example, for the L000 OpenStudio Simulation use case, there are [2 examples files](https://github.com/BuildingSync/TestSuite/tree/develop/spec/use_cases/schema2.0.0/examples)), add them in the appropriate schema directory in ```bsyncviewer/lib/validator/examples```. Regenerate the ```example_files.zip``` archive.  This will make the files available as examples at the ```/validator``` URL.
 1. You can now validate XMLs against the new use case.

README.md

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# This backup script creates nightly database and media file backups of the Selection Tool when running
+# in a docker container. The name of the container running the database is hardcoded to look for
+# *db-postgres*. This may cause an issue if several docker applications are running on the same
+# system. Also, the location of the backups is hardcoded to ~/selection-tool-backups.
+
+# To create nightly backups, add the following to your crontab
+# 0 0 * * * /srv/selection-tool/backup_database.sh <db_name> <db_username> >> /home/ubuntu/selection-tool-backups/cron.log 2>&1
+
+DB_NAME=$1
+DB_USERNAME=$2
+
+function file_name(){
+    echo ${BACKUP_DIR}/${DB_NAME}_$(date '+%Y%m%d_%H%M%S').dump
+}
+
+function media_file_name(){
+    echo /backup/dir/${DB_NAME}_media_$(date '+%Y%m%d_%H%M%S').tgz
+}
+
+if [[ (-z ${DB_NAME}) || (-z ${DB_USERNAME}) ]] ; then
+    echo "Expecting command to be of form ./backup_database.sh <db_name> <db_username>"
+    exit 1
+fi
+
+# currently the backup directory is hard coded
+BACKUP_DIR=/home/ubuntu/selection-tool-backups
+mkdir -p ${BACKUP_DIR}
+
+# db_password is set from the environment variables in docker-compose. The docker stack must
+# be running for this command to work.
+echo "docker exec $(docker ps -f "name=db-postgres" --format "{{.ID}}") pg_dump -U ${DB_USERNAME} -Fc ${DB_NAME} > $(file_name)"
+docker exec $(docker ps -f "name=db-postgres" --format "{{.ID}}") pg_dump -U ${DB_USERNAME} -Fc ${DB_NAME} > $(file_name)
+
+
+# Backup the media directory (uploads, especially buildingsync). In docker-land this is
+# just a container volume, so create a new container with the volume attached and tar it up.
+echo "docker run --rm -it -v selectiontool_mediadata:/backup/media -v $BACKUP_DIR:/backup/dir/ alpine:3.8 tar zcvf $(media_file_name) /backup/media"
+docker run --rm -v selectiontool_mediadata:/backup/media -v $BACKUP_DIR:/backup/dir/ alpine:3.8 tar zcvf $(media_file_name) /backup/media
+
+# Delete files older than 30 days.
+find ${BACKUP_DIR} -mtime +30 -type f -name '*.dump' -delete
+find ${BACKUP_DIR} -mtime +30 -type f -name '*.tgz' -delete

backup_database.sh

@@ -46155,4 +46155,4 @@
       "list_options": []
     }
   ]
-}
+}