update branch

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,65 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: '0 4 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Override automatic language detection by changing the below list
+        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
+        language: ['python', 'javascript']
+        # Learn more...
+        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file. 
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.gitignore

@@ -23,6 +23,7 @@ configs/coords/*
 status.json
 update_log.json
 commands.json
+.tox/
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.gitlint

@@ -0,0 +1,8 @@
+[general]
+ignore=title-trailing-punctuation, title-must-not-contain-word
+
+[title-max-length]
+line-length=120
+
+[body-max-line-length]
+line-length=140

.gitmessage

@@ -0,0 +1,5 @@
+# (ISSUE IF APPLICABLE) SHORT_DESCRIPTION
+
+# LONG_DESCRIPTION
+#   * Thing 1
+#   * Thing 2

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+known_third_party = PIL,aioconsole,apkutils,bitstring,configargparse,cv2,dataclasses,flask,flask_caching,gevent,google,gpapi,gpxdata,imutils,loguru,mysql,numpy,pkg_resources,psutil,pytesseract,pytest,requests,s2sphere,urllib3,websockets,werkzeug

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+repos:
+  - repo: https://github.com/Seeefo/manage-commit-msg.git
+    rev: 1.0.3
+    hooks:
+      - id: restore-commit-msg
+  - repo: https://github.com/jorisroovers/gitlint
+    rev: v0.13.1
+    hooks:
+      - id: gitlint
+  - repo: https://github.com/Seeefo/manage-commit-msg.git
+    rev: 1.0.3
+    hooks:
+      - id: save-commit-msg
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.9
+    hooks:
+      - id: flake8
+        language_version: python3
+        additional_dependencies: [flake8-bugbear, flake8-logging-format, flake8-variables-names, pep8-naming, flake8-eradicate]
+  - repo: https://github.com/asottile/seed-isort-config
+    rev: v2.1.0
+    hooks:
+      - id: seed-isort-config
+        language_version: python3
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v4.3.21
+    hooks:
+      - id: isort
+        language_version: python3
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer

.travis.yml

@@ -20,7 +20,7 @@ install:
   - pip3 install flake8 flake8-variables-names flake8-logging-format pep8-naming flake8-eradicate
 script:
   - python3 -m flake8
-  - python3 start.py -ut -wm -cm -cf configs/config.ini.travis -mf configs/mappings.travis.json
+  - python3 start.py -ut -cm -cf configs/config.ini.travis -mf configs/mappings.travis.json
   - mysql -u root -e "DROP DATABASE mad;"
   - mysql -u root -e "CREATE DATABASE mad;"
-  - python3 start.py -ut -wm -cf configs/config.ini.travis -mf configs/mappings.travis.json
+  - python3 start.py -ut -cf configs/config.ini.travis -mf configs/mappings.travis.json

Makefile

@@ -0,0 +1,149 @@
+CMD ?= bash
+CONTAINER_NAME ?= mapadroid-dev
+include docker/.dev.env
+export
+
+define PIP_MISSING
+Pip is missing or not available in PATH. If pip is not installed
+instructions can be found at https://pip.pypa.io/en/stable/installing/
+endef
+
+define PRE_COMMIT_MISSING
+Install pre-commit @ https://pre-commit.com/#install then run
+source ~/.profile
+endef
+
+define DOCKER_MISSING
+Docker installation is missing or not available. This could be caused by
+not having docker installed or the user does not have access to docker.
+Installation instructions can be found at
+https://docs.docker.com/get-docker/
+endef
+
+define DOCKER_NOT_RUNNING
+Docker is not running or the user does not have access to the Docker
+Engine. Please verify that its running and you have access. On *nix
+systems you can run the following commands to grant access:
+sudo groupadd docker
+sudo usermod -aG docker $USER
+newgrp docker
+endef
+
+define DOCKER_COMPOSE_MISSING
+docker-compose -f ${COMPOSE_FILE_DEV} is not installed or not available in PATH. Installation
+instructions can be found at https://docs.docker.com/compose/install/
+If docker-compose -f ${COMPOSE_FILE_DEV} is installed PATH needs to be corrected to include
+the binary
+endef
+
+define DOCKER_COMPOSE_OLD
+docker-compose -f ${COMPOSE_FILE_DEV} is too old. Update docker-compose -f ${COMPOSE_FILE_DEV} from the instructions at
+https://docs.docker.com/compose/install/
+endef
+
+# Windows defines OS but *nix does not
+ifdef OS
+    SHELL := powershell.exe
+    pip := $(shell Get-Command pip | Select-Object -ExpandProperty Source)
+    precommit := $(shell Get-Command pre-commit | Select-Object -ExpandProperty Source)
+    docker := $(shell Get-Command docker | Select-Object -ExpandProperty Source)
+    docker_compose := $(shell Get-Command docker-compose -f ${COMPOSE_FILE_DEV} | Select-Object -ExpandProperty Source)
+    UID ?= 1000
+    GID ?= 1000
+else
+    ifneq ($(shell which pip),)
+        pip := $(shell which pip)
+    else ifneq ($(shell which pip3),)
+        pip := $(shell which pip3)
+    else
+        $(error $(PIP_MISSING))
+    endif
+    precommit := $(shell which pre-commit)
+    docker := $(shell which docker)
+    docker_compose := $(shell which docker-compose -f ${COMPOSE_FILE_DEV})
+    UID ?= $(shell id -u)
+    GID ?= $(shell id -g)
+endif
+
+
+ifeq (, $(pip))
+    $(error $(PIP_MISSING))
+endif
+ifneq ($(VIRTUAL_ENV), )
+    pip_precommit_installation := $(pip) install pre-commit
+else
+    pip_precommit_installation := $(pip) install --user pre-commit
+endif
+ifeq (, $(precommit))
+    $(error $(PRE_COMMIT_MISSING))
+endif
+ifeq (, $(docker))
+    $(error $(DOCKER_MISSING))
+endif
+ifeq (, $(shell docker info))
+    $(error $(DOCKER_NOT_RUNNING))
+endif
+ifeq (, $(docker_compose))
+    $(error $(DOCKER_COMPOSE_MISSING))
+endif
+compose_ver ?= $(shell docker-compose -f ${COMPOSE_FILE_DEV} --version | cut -d' ' -f3 | cut -d '.' -f2)
+ifeq (, compose_ver < 27)
+    $(error $(DOCKER_COMPOSE_OLD))
+endif
+
+clean: clean-tox down
+
+clean-tox:
+	rm -rf .tox
+
+build:
+	docker build --file docker/Dockerfile --tag ${LOCAL_MAD_IMAGE} .
+	docker-compose -f ${COMPOSE_FILE_DEV} build --no-cache
+
+rebuild:
+	docker build --file docker/Dockerfile --tag ${LOCAL_MAD_IMAGE} .
+	docker-compose -f ${COMPOSE_FILE_DEV} build
+
+setup-precommit:
+	$(pip_precommit_installation)
+	pre-commit install
+	pre-commit install --hook-type commit-msg
+
+setup: setup-precommit
+	git config commit.template .gitmessage
+
+up:
+	docker-compose -f ${COMPOSE_FILE_DEV} up --detach
+
+shell: up
+	docker-compose -f ${COMPOSE_FILE_DEV} exec $(CONTAINER_NAME) $(CMD)
+
+root-shell: up
+	docker-compose -f ${COMPOSE_FILE_DEV} exec -u root $(CONTAINER_NAME) $(CMD)
+
+down:
+	docker-compose -f ${COMPOSE_FILE_DEV} down
+
+tests: up
+	docker-compose -f ${COMPOSE_FILE_DEV} exec mapadroid-dev tox
+
+unittests: up
+	docker-compose -f ${COMPOSE_FILE_DEV} exec mapadroid-dev tox -e py37
+
+# Run bash within a defined tox environment
+# Specify a valid tox environment as such:
+#       make shell-py37
+# To force a recreation of the environment, specify the RECREATE environment variable with any value
+#   make shell-py37 RECREATE=1
+shell-%: up
+ifdef RECREATE
+	docker-compose -f ${COMPOSE_FILE_DEV} exec mapadroid-dev tox -e $* --recreate -- bash
+else
+	docker-compose -f ${COMPOSE_FILE_DEV} exec mapadroid-dev tox -e $* -- bash
+endif
+
+versions:
+	$(pip) --version
+	$(precommit) --version
+	$(docker) --version
+	$(docker_compose) --version