fix up things

Author: gaborbernat

.gitignore

@@ -1 +1,2 @@
 .idea
+.tox

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.1.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml

README.md

@@ -9,7 +9,7 @@ configuration when using [tox](https://tox.readthedocs.org) to drive your CI.
 
 It is suggested to use a generic name, such as `github` so forks can also configure the same.
 
-You can find this in `Project Settings` => `Service connections` in the Azure Devops dashboard for your project. 
+You can find this in `Project Settings` => `Service connections` in the Azure Devops dashboard for your project.
 Project settings is located in the bottom left corner of the UI as of 2019-04-30. Below I'm using the endpoint name
 `github`.
 
@@ -30,7 +30,7 @@ this will make the templates in this repository available in the `tox` namespace
 # job templates
 
 ## `run-tox-env.yml`
-This job template will run tox for a given set of tox targets on given platform (new in `0.1`). 
+This job template will run tox for a given set of tox targets on given platform (new in `0.1`).
 Features and functionality:
 
 - each specified toxenv target maps to a single Azure Pipelines job
@@ -46,7 +46,7 @@ Features and functionality:
 The following example will run `py36` and `py37` on Windows, Linux and MacOs. It will also invoke
 `fix_lint` and `docs` target with `python3.7` on Linux. Note how the root level name can be used
 to automatically specify the target platform (defaults to Linux).
-               
+
 ```yaml
 jobs:
 - template: run-tox-env.yml@tox
@@ -75,9 +75,9 @@ jobs:
 ### parameters
 
 At root level you can control with `tox_version` the tox version specifier to install, this defaults to latest in PyPi
-(`tox`). Beside this at the root level we have the ``jobs`` key. Inside this you can enlist groups of targets as maps. 
+(`tox`). Beside this at the root level we have the ``jobs`` key. Inside this you can enlist groups of targets as maps.
 The key is the name of the group. The values configure the target:
- 
+
 - `toxenvs`: the list of `tox` environment names to run; must either:
   - be equal to: `py27`, `py34`, `py35`, `py36`, `py37`, `py38`, `jython`, `pypy`, `pypy3`
   - start with: `py27-`, `py34-`, `py35-`, `py36-`, `py37-`, `py38-`, `jython-`, `pypy-`, `pypy3`
@@ -101,7 +101,7 @@ Note, for now:
 
 This job template will download coverage files attached to the build (uploaded by `run-tox-env.yml`)
 and use target tox environment configured to generate a unified report. This then will be uploaded
-to the Azure Pipelines coverage report. 
+to the Azure Pipelines coverage report.
 
 ### example
 
@@ -118,12 +118,12 @@ to the Azure Pipelines coverage report.
 ### parameters
 - `coverage` - tox target that generates the unified coverage report (default `coverage`)
 - `dependsOn` - environments this job depends on
-- `tox_version` - the tox version specifier to use, defaults to latest 
+- `tox_version` - the tox version specifier to use, defaults to latest
 
 ## `publish-pypi.yml`
 
 This job template will publish the Python package in the current folder (both sdist and wheel)
-via the PEP-517/8 build mechanism and twine. 
+via the PEP-517/8 build mechanism and twine.
 
 ### example
 
@@ -140,5 +140,5 @@ via the PEP-517/8 build mechanism and twine.
 
 ### parameters
 - `external_feed` - the external feed to upload
-- `pypi_remote` - the pypi remote to upload to 
-- `dependsOn` - environments this job depends on 
+- `pypi_remote` - the pypi remote to upload to
+- `dependsOn` - environments this job depends on

azure-pipelines.yml

@@ -0,0 +1,18 @@
+name: $(BuildDefinitionName)_$(Date:yyyyMMdd)$(Rev:.rr)
+
+trigger:
+  batch: true
+  branches:
+    include:
+    - master
+    - refs/tags/*
+pr:
+  branches:
+    include:
+    - master
+
+jobs:
+- template: run-tox-env.yml
+  parameters:
+    jobs:
+      fix_lint: null

merge-coverage.yml

@@ -1,6 +1,6 @@
 parameters:
   dependsOn: []
-  coverage: 'coverage'
+  toxenv: 'coverage'
   tox_version: 'tox'
 
 jobs:
@@ -11,7 +11,7 @@ jobs:
   variables:
     TMPDIR: $(Build.BinariesDirectory)
     PIP_NO_WARN_SCRIPT_LOCATION: '0'
-    TOXENV: ${{ parameters.coverage }}
+    TOXENV: ${{ parameters.toxenv }}
   steps:
   - task: DownloadBuildArtifacts@0
     displayName: download coverage files for run

run-tox-env.yml

@@ -1,8 +1,9 @@
 parameters:
   jobs: []
   tox_version: 'tox'
-  before: []
-  env: []
+  coverage:
+    with_toxenv: ''
+    for_envs: []
 
 jobs:
 - ${{ each job in parameters.jobs }}:
@@ -122,25 +123,26 @@ jobs:
         testRunTitle: 'junit-$(Agent.OS)-$(Agent.OSArchitecture)-$(TOXENV)'
 
     # upload coverage artifacts if present
-    - ${{ if job.value.coverage }}:
-      - script:  ${{ format('$(toxPython.pythonLocation)/python -m tox -e {0}', job.value.coverage) }}
+    - ${{ if and(parameters.coverage.with_toxenv, containsValue(parameters.coverage.for_envs, job.key)) }}:
+      - script:  ${{ format('$(toxPython.pythonLocation)/python -m tox -e {0} --skip-missing-interpreters false', parameters.coverage.with_toxenv) }}
         displayName: create coverag report
-    - bash: 'printf "##vso[task.setVariable variable=coverage]" && ([ -f coverage.xml -o -f .coverage ] && printf yes || printf no) && echo ""'
-      displayName: check if coverage file present
-      condition: always()
-      workingDirectory: '$(System.DefaultWorkingDirectory)/.tox'
-    - task: CopyFiles@2
-      displayName: move coverage files into staging area
-      condition: eq(variables.coverage, 'yes')
-      inputs:
-        sourceFolder: $(System.DefaultWorkingDirectory)/.tox
-        contents: |
-          .coverage
-          coverage.xml
-        targetFolder: $(Build.StagingDirectory)
-    - task: PublishBuildArtifacts@1
-      displayName: publish coverage file
-      condition: eq(variables.coverage, 'yes')
-      inputs:
-        pathtoPublish: $(Build.ArtifactStagingDirectory)
-        ArtifactName: 'coverage-$(Agent.OS)-$(Agent.OSArchitecture)-$(TOXENV)'
+      - task: CopyFiles@2
+        displayName: move coverage files into staging area
+        inputs:
+          sourceFolder: $(System.DefaultWorkingDirectory)/.tox
+          contents: |
+            .coverage
+            coverage.xml
+          targetFolder: $(Build.StagingDirectory)
+      - task: PublishBuildArtifacts@1
+        displayName: publish coverage file
+        inputs:
+          pathtoPublish: $(Build.ArtifactStagingDirectory)
+          ArtifactName: 'coverage-$(Agent.OS)-$(Agent.OSArchitecture)-$(TOXENV)'
+
+- ${{ if and(parameters.coverage.with_toxenv, parameters.coverage.for_envs) }}:
+  - template: merge-coverage.yml@tox
+    parameters:
+      tox_version: ${{ parameters.tox_version }}
+      toxenv: ${{ parameters.coverage.with_toxenv }}
+      dependsOn: ${{ parameters.coverage.for_envs }}

tox.ini

@@ -0,0 +1,14 @@
+[tox]
+envlist = fix_lint
+skipsdist = true
+
+[testenv:fix_lint]
+description = format the code base to adhere to our styles, and complain about what we cannot do automatically
+basepython = python3.7
+passenv = # without PROGRAMDATA cloning using git for Windows will fail with an `error setting certificate verify locations` error
+          PROGRAMDATA
+extras = lint
+deps = pre-commit >= 1.14.4, < 2
+skip_install = True
+commands = pre-commit run --all-files --show-diff-on-failure
+           python -c 'import pathlib; print("hint: run \{\} install to add checks as pre-commit hook".format(pathlib.Path(r"{envdir}") / "bin" / "pre-commit"))'