Upgrade to Django 2.2 and Python 3

.gitignore

@@ -6,3 +6,5 @@ htmlselenium
 *.pyc
 dist
 *egg-info
+public
+_modules

.gitlab-ci.yml

@@ -0,0 +1,112 @@
+# turn on all of the security pipelines
+include:
+  - template: Dependency-Scanning.gitlab-ci.yml
+  - template: SAST.gitlab-ci.yml
+  - template: DAST.gitlab-ci.yml
+  - template: License-Scanning.gitlab-ci.yml
+
+variables:
+  # Disable Docker-in-Docker so gemnasium scan uses build container
+  DS_DISABLE_DIND: "true"
+
+dependency_scanning:
+  before_script:
+    # Install system dependencies required by `pip install requirements.txt`
+    - apt-get install -y python3-dev postgresql libpq-dev
+
+test:
+  stage: test
+  image: centos:7
+  services:
+    - postgres:latest
+  variables:
+    PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+    POSTGRES_DB: ci
+    POSTGRES_USER: postgres
+    POSTGRES_PASSWORD: postgres
+    POSTGRES_HOST_AUTH_METHOD: trust
+    DATABASE_URL: "postgresql://postgres:postgres@postgres:5432/ci"
+    DATABASE_HOST: postgres
+    DATABASE_NAME: $POSTGRES_DB
+    DATABASE_USER: $POSTGRES_USER
+    DATABASE_PASSWORD: $POSTGRES_PASSWORD
+  cache:
+    paths:
+      - .cache/pip
+  before_script:
+    # install required base packages
+    - yum -y install make gcc python3 python3-devel python3-pip git tree wget unzip
+      postgresql-devel postgresql-server postgresql-contrib
+    # install chrome
+    - wget https://dl.google.com/linux/direct/google-chrome-stable_current_x86_64.rpm
+    - yum -y localinstall google-chrome-stable_current_x86_64.rpm
+    # install latest chromedriver
+    - export LATEST_RELEASE=$(curl http://chromedriver.storage.googleapis.com/LATEST_RELEASE)
+    - wget https://chromedriver.storage.googleapis.com/$LATEST_RELEASE/chromedriver_linux64.zip
+    - mkdir chromedriver
+    - unzip chromedriver_linux64.zip -d chromedriver
+    - export PATH=$PATH:$PWD/chromedriver
+    # configure python 3 virtualenv
+    - pip3 install virtualenv
+    - virtualenv venv
+    - source venv/bin/activate
+    # install package requirements
+    - make reqs
+  script:
+    - python -V
+    - export PGPASSWORD=$POSTGRES_PASSWORD
+    - psql -h "postgres" -U "$POSTGRES_USER" -d "$POSTGRES_DB" -c "SELECT 'OK' AS status;"
+    - make all
+  artifacts:
+    paths:
+    - public
+  rules:
+    - if: $CI_COMMIT_BRANCH != "master"
+
+# deploy documentation to pages
+pages:
+  stage: deploy
+  image: centos:7
+  services:
+    - postgres:latest
+  variables:
+    PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+    POSTGRES_DB: ci
+    POSTGRES_USER: postgres
+    POSTGRES_PASSWORD: postgres
+    POSTGRES_HOST_AUTH_METHOD: trust
+    DATABASE_URL: "postgresql://postgres:postgres@postgres:5432/ci"
+    DATABASE_HOST: postgres
+    DATABASE_NAME: $POSTGRES_DB
+    DATABASE_USER: $POSTGRES_USER
+    DATABASE_PASSWORD: $POSTGRES_PASSWORD
+  cache:
+    paths:
+      - .cache/pip
+  before_script:
+    # install required base packages
+    - yum -y install make gcc python3 python3-devel python3-pip git tree wget unzip
+      postgresql-devel postgresql-server postgresql-contrib
+    # install chrome
+    - wget https://dl.google.com/linux/direct/google-chrome-stable_current_x86_64.rpm
+    - yum -y localinstall google-chrome-stable_current_x86_64.rpm
+    # install latest chromedriver
+    - export LATEST_RELEASE=$(curl http://chromedriver.storage.googleapis.com/LATEST_RELEASE)
+    - wget https://chromedriver.storage.googleapis.com/$LATEST_RELEASE/chromedriver_linux64.zip
+    - mkdir chromedriver
+    - unzip chromedriver_linux64.zip -d chromedriver
+    - export PATH=$PATH:$PWD/chromedriver
+    # configure python 3 virtualenv
+    - pip3 install virtualenv
+    - virtualenv venv
+    - source venv/bin/activate
+    # install package requirements
+    - make reqs
+  script:
+    - python -V
+    - make all
+  artifacts:
+    paths:
+    - public
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master"

.travis.yml

@@ -1,7 +1,5 @@
 sudo: required
 language: python
-python:
-  - "2.7"
 addons:
   chrome: stable
   firefox: latest

CHANGES

@@ -1,3 +1,7 @@
+1.3.2 (2020-03-24):
+
+    * Update django-selenium-testcase for python3
+
 1.3.1 (2019-07-08):
 
     * Add method hover_over_button to the NavigationTestMixin to

Makefile

@@ -1,75 +1,115 @@
-.PHONY: check-venv test pep8 clean coverage
-
-# Clean out potentially stale pyc files
+# You can set these variables from the command line
+# arguments for sphinx-apidoc autodoc builds
+
+SPHINXOPTS     ?= -n
+SPHINXBUILD    ?= sphinx-build
+SOURCEDIR      ?= docs
+BUILDDIR       ?= public
+APIOPTS        ?= -f -e
+APIDOCBUILD    ?= sphinx-apidoc
+APISOURCE      ?= selenium_testcase
+APIDEST        ?= docs/_modules
+
+# Put it first so that "make" without argument is like "make help".
+.PHONY: help
+help:
+	@echo "*** Help ***"
+	@echo "  all           make clean pep8 flake8 test coverage docs"
+	@echo "  clean         remove generaed build files"
+	@echo "  coverage      run tests with code coverage being computed"
+	@echo "  reqs          update your requirements from requirements.txt"
+	@echo "  reqs-update   compile requirements.txt from requirements.in"
+	@echo "  test          run tests"
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# run a complete test suite
+.PHONY: all
+all:
+	@echo -e "section_start:`date +%s`:make_clean\r\e[0KMake clean"
+	make clean
+	@echo -e "section_end:`date +%s`:make_clean\r\e[0K"
+	@echo -e "section_start:`date +%s`:make_pycodestyle\r\e[0KMake pycodestyle"
+	make pycodestyle
+	@echo -e "section_end:`date +%s`:make_pycodestyle\r\e[0K"
+	@echo -e "section_start:`date +%s`:make_flake8\r\e[0Kmake flake8"
+	make flake8
+	@echo -e "section_end:`date +%s`:make_flake8\r\e[0K"
+	@echo -e "section_start:`date +%s`:make_coverage\r\e[0Kmake coverage"
+	make coverage
+	make tree
+	@echo -e "section_end:`date +%s`:make_coverage\r\e[0K"
+	@echo -e "section_start:`date +%s`:make_docs\r\e[0Kmake docs"
+	make docs
+	@echo -e "section_end:`date +%s`:make_docs\r\e[0K"
+
+# make all docs
+.PHONY: docs
+docs:
+	make linkcheck
+	make html
+
+# clear the generated files
+.PHONY: clean
 clean:
-	find . -name "*.pyc" -exec rm {} \;
-
-# Check that virtualenv is enabled
-check-venv:
-ifndef VIRTUAL_ENV
-	$(error VIRTUAL_ENV is undefined, try "workon" command)
-endif
-
-# Install pip requirements.txt file
-reqs: check-venv
-	pip install --upgrade -r requirements.txt
-
-PEP8_OPTS=--repeat --exclude=static,migrations,js,doc --show-source
-
-pep8:
-	pep8 $(PEP8_OPTS) .
-
-FLAKE8_OPTS=--exclude=static,migrations,js,doc
+	rm -rf $(BUILDDIR)/* $(APIDEST)
+	find . -name __pycache__ | xargs rm -rf
+
+# install requirements using pip
+.PHONY: reqs
+reqs:
+	pip install --require-hashes --upgrade -r requirements.txt
+
+# use pip-compile to lock down requirements
+.PHONY: update-reqs reqs-update
+update-reqs reqs-update:
+	pip-compile --no-index --generate-hashes --allow-unsafe
+
+# pep8
+.PHONY: pep8 pycodestyle
+PEP8_OPTS ?= --repeat --exclude=static,migrations,js,docs,venv --show-source
+pep8 pycodestyle:
+	pycodestyle $(PEP8_OPTS) .
+
+# flake8
+.PHONY: flake8
+FLAKE8_OPTS ?= --exclude=static,migrations,js,docs,venv
 flake8:
 	flake8 $(FLAKE8_OPTS) .
 
-#
-# Unit tests
-#
+# test
+.PHONY: test
+TEST_OPTS ?= -v 2
+test:
+	python ./manage.py test $(TEST_OPTS)
 
-test: check-venv clean
-	python ./manage.py test --keepdb -v 2
-
-travis-tests: check-venv
-	@echo "travis_fold:start:flake8"
-	make flake8
-	@echo "travis_fold:end:flake8"
-
-	@echo "travis_fold:start:pip_freeze"
-	pip freeze -l
-	@echo "travis_fold:end:pip_freeze"
-
-	coverage erase
-	@echo "travis_fold:start:test"
-	coverage run $(COVERAGE_ARGS) ./manage.py test --keepdb -v 2
-	@echo "travis_fold:end:test"
-
-	@echo "travis_fold:start:coverage"
-	coverage report
-	coverage html
-	@echo "travis_fold:end:coverage"
-
-#
-# Run a django instance with a test project for the current app
-#
+# tree
+.PHONY: tree
+tree:
+	cd public/htmlselenium; tree -h -H . > index.html
 
+# run
 .PHONY: run
-run: check-venv clean
-	python ./manage.py runserver
+RUN_OPTS ?=
+run:
+	python ./manage.py $(RUN_OPTS) runserver
 
-#
-# Code coverage
-#
+# coverage
 
-COVERAGE_ARGS=--source=selenium_testcase --omit=/tests
-
-coverage: check-venv
+COVERAGE_ARGS ?= --source=$(APISOURCE) --omit=/tests
+COVERAGE_OPTS ?= --keepdb -v 2
+COVERAGE_REPORT_OPTS ?= -m
+COVERAGE_HTML_OPTS ?= -d public/coverage
+coverage:
 	coverage erase
-	coverage run $(COVERAGE_ARGS) ./manage.py test --keepdb -v 2
-	coverage report
-	coverage html
-	@echo "See ./htmlcov/index.html for coverage report"
-
-develop-%: check-venv
-	cd ../$*; python setup.py develop -N
-
+	coverage run $(COVERAGE_ARGS) ./manage.py test $(COVERAGE_OPTS)
+	coverage report $(COVERAGE_REPORT_OPTS)
+	coverage html $(COVERAGE_HTML_OPTS)
+	@echo "See ./public/coverage/index.html for coverage report"
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%:
+ifdef APISOURCE
+	@$(APIDOCBUILD) -o "$(APIDEST)" "$(APISOURCE)" $(APIOPTS)
+endif
+	@$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -1,8 +1,18 @@
 django-selenium-testcase
 ========================
 
-[![Build Status](https://travis-ci.org/nimbis/django-selenium-testcase.svg?branch=master)](https://travis-ci.org/nimbis/django-selenium-testcase)
+[![pipeline status](https://gitlab.nimbis.io/nimbis/sites/django-selenium-testcase/badges/master/pipeline.svg)](https://gitlab.nimbis.io/nimbis/sites/django-selenium-testcase/-/commits/master)
+[![coverage report](https://gitlab.nimbis.io/nimbis/sites/django-selenium-testcase/badges/master/coverage.svg)](https://gitlab.nimbis.io/nimbis/sites/django-selenium-testcase/-/commits/master)
 
+Quick Links
+-----------
+
+* [Online Documentation](https://nimbis.pages.nimbis.io/sites/django-selenium-testcase/index.html)
+* [Coverage Report](https://nimbis.pages.nimbis.io/sites/django-selenium-testcase/coverage/index.html)
+* [Selenium Test](https://nimbis.pages.nimbis.io/sites/django-selenium-testcase/htmlselenium/index.html)
+
+Introduction
+------------
 This repository implements a simple subclass of Django LiveServerTestCase that
 enables selenium testing of the Django live server.  Rather than relying on
 Gherkin syntax found in Lettuce and Aloe tools, this package favors of python

docs/README.md

@@ -0,0 +1 @@
+../README.md

docs/_templates/breadcrumbs.html

@@ -0,0 +1,29 @@
+{% extends "!breadcrumbs.html" %}
+
+{% block breadcrumbs_aside %}
+    {% if selenium_url %}
+    <li class="wy-breadcrumbs-aside">
+        <a href="{{ selenium_url }}" class="fa fa-film" title="View Selenium"> </a>
+    </li>
+    {% endif %}
+    {% if coverage_url %}
+    <li class="wy-breadcrumbs-aside">
+        <a href="{{ coverage_url }}" class="fa fa-umbrella" title="View Coverage"> </a>
+    </li>
+    {% endif %}
+    {% if pdf_url %}
+    <li class="wy-breadcrumbs-aside">
+        <a href="{{ pdf_url }}" class="fa fa-print" title="View PDF"> </a>
+    </li>
+    {% endif %}
+    {% if ide_url %}
+    <li class="wy-breadcrumbs-aside">
+        <a href="{{ ide_url }}{{ pagename }}{{ suffix }}" class="fa fa-pencil-square-o" title="Edit on GitLab"></a>
+    </li>
+    {% endif %}
+    {% if gitlab_url %}
+    <li class="wy-breadcrumbs-aside">
+        <a href="{{ gitlab_url }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab" title="View Source"> </a>
+    </li>
+    {% endif %}
+{% endblock %}