Create a devcontainer to ease dev setup (#1381)

Author: adehad

.devcontainer/Dockerfile

@@ -0,0 +1,9 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.231.5/containers/ubuntu/.devcontainer/base.Dockerfile
+
+# [Choice] Ubuntu version (use hirsuite or bionic on local arm64/Apple Silicon): hirsute, focal, bionic
+ARG VARIANT="hirsute"
+FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends \

.devcontainer/devcontainer.json

@@ -0,0 +1,84 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.231.5/containers/ubuntu
+{
+	"name": "Ubuntu",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick an Ubuntu version: hirsute, focal, bionic
+		// Use hirsute or bionic on local arm64/Apple Silicon.
+		"args": {
+			"VARIANT": "focal"
+		}
+	},
+	// Set *default* container specific settings.json values on container create.
+	"settings": {
+		"[python]": {
+			"editor.codeActionsOnSave": {
+				"source.organizeImports": true,
+				"editor.formatOnSave": true,
+			},
+			"editor.formatOnSave": true, // Required to actually format on save
+		},
+		"editor.rulers": [
+			80, // default color or as customized (with "editorRuler.foreground")
+			{
+				"column": 88,
+				"color": "#ff000065"
+			},
+		],
+		"python.defaultInterpreterPath": "/usr/local/python/bin/python",
+		"python.formatting.provider": "black",
+		"python.linting.mypyEnabled": true,
+		"python.linting.mypyPath": "mypy",
+		"python.linting.mypyArgs": [
+			"--follow-imports=silent",
+			"--ignore-missing-imports",
+			"--show-column-numbers",
+			"--show-error-codes"
+		],
+		"python.linting.ignorePatterns": [
+			"**/site-packages/",
+			".vscode/*.py",
+			"**/.tox/",
+			"*.pyi",
+			"**/dist/"
+		],
+		"search.exclude": {
+			"**/build/lib/*": true,
+			"**/dist/*": true,
+		},
+		"python.testing.pytestArgs": [
+			"--no-cov",
+			"-v",
+			"tests/"
+		],
+		"python.testing.pytestEnabled": true,
+		"python.testing.pytestPath": "pytest",
+	},
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"njpwerner.autodocstring",
+		"yzhang.markdown-all-in-one",
+		"ms-python.python",
+		"littlefoxteam.vscode-python-test-adapter",
+		"ms-vscode-remote.remote-containers",
+		"hbenl.vscode-test-explorer",
+		"trond-snekvik.simple-rst",
+		"wayou.vscode-todo-highlight",
+		"ms-azuretools.vscode-docker"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	"forwardPorts": [
+		// The jira server instance we run via docker is exposed on:
+		2990
+	],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "./.devcontainer/post_create.sh",
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	// "remoteUser": "vscode",
+	"features": {
+		"docker-in-docker": "latest",
+		"git": "latest",
+		"python": "3.10"
+	}
+}

.devcontainer/post_create.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+# This file is run from the .vscode folder
+WORKSPACE_FOLDER=/workspaces/jira
+
+# Start the Jira Server docker instance first so can be running while we initialise everything else
+# Need to ensure this --version matches what is in CI
+echo "Initiating jira server instance, use the docker extension to inspect the logs (takes around 10/15mins to startup)"
+docker run -dit -p 2990:2990 --name jira addono/jira-software-standalone --version 8.17.1
+echo "Once started up, Jira host port is forwarded and can be found on: localhost:2990/jira/"
+
+# For Windows uses that have cloned into Windows' partition, we do this so that
+# it doesn't show all the files as "changed" for having different line endings.
+# As we use pre-commit for managing our line endings we do this to tell git we don't care
+git config --global core.autocrlf input
+git add .
+
+# Install tox and pre-commit
+pipx install pre-commit
+pipx install tox
+
+# Sanity check that we can run pre-commit env
+pre-commit run mypy --all-files
+
+# Set the PIP_CONSTRAINT env variable
+PIP_CONSTRAINT=$WORKSPACE_FOLDER/constraints.txt
+if [ -f "$PIP_CONSTRAINT" ]; then
+    echo "$PIP_CONSTRAINT found, use 'unset PIP_CONSTRAINT' if you want to remove the constraints."
+    echo "export PIP_CONSTRAINT="$PIP_CONSTRAINT"" >> ~/.bashrc && source ~/.bashrc
+else
+    echo "$PIP_CONSTRAINT was not found, dependencies are not controlled."
+fi
+
+# Install package in editable mode with test dependencies
+pip install -e .[test]