Skip to content

Commit 66572dc

Browse files
PaebbelsPaebbels
authored
v1.0.0
2 parents adef08d + 5663891 commit 66572dc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+6143
-377
lines changed

‎.btd.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
input: doc
2+
output: _build
3+
requirements: requirements.txt
4+
target: gh-pages
5+
formats: [ html ]
6+
images:
7+
base: btdi/sphinx:pytooling
8+
latex: btdi/latex
9+
theme: https://codeload.GitHub.com/buildthedocs/sphinx.theme/tar.gz/v1

‎.editorconfig

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
# end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_style = tab
9+
indent_size = 2
10+
tab_width = 2
11+
12+
13+
[*.py]
14+
indent_style = tab
15+
indent_size = 2
16+
17+
[*.{yml,yaml}]
18+
indent_style = space
19+
indent_size = 2
20+
21+
[*.{json,ini}]
22+
indent_style = tab
23+
indent_size = 2
24+
25+
[*.md]
26+
trim_trailing_whitespace = false
27+
28+
[*.rst]
29+
indent_style = space
30+
indent_size = 3

‎.github/dependabot.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ updates:
1010
- Dependencies
1111
assignees:
1212
- Paebbels
13-
- Umarcor
13+
- umarcor
1414
reviewers:
1515
- Paebbels
16-
- Umarcor
16+
- umarcor
1717
schedule:
1818
interval: "daily" # Checks on Monday trough Friday.

‎.github/workflows/ApplicationTesting.yml

+255
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
1+
# ==================================================================================================================== #
2+
# Authors: #
3+
# Patrick Lehmann #
4+
# Unai Martinez-Corral #
5+
# #
6+
# ==================================================================================================================== #
7+
# Copyright 2020-2024 The pyTooling Authors #
8+
# #
9+
# Licensed under the Apache License, Version 2.0 (the "License"); #
10+
# you may not use this file except in compliance with the License. #
11+
# You may obtain a copy of the License at #
12+
# #
13+
# http://www.apache.org/licenses/LICENSE-2.0 #
14+
# #
15+
# Unless required by applicable law or agreed to in writing, software #
16+
# distributed under the License is distributed on an "AS IS" BASIS, #
17+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
18+
# See the License for the specific language governing permissions and #
19+
# limitations under the License. #
20+
# #
21+
# SPDX-License-Identifier: Apache-2.0 #
22+
# ==================================================================================================================== #
23+
name: Application Testing
24+
25+
on:
26+
workflow_call:
27+
inputs:
28+
jobs:
29+
description: 'JSON list with environment fields, telling the system and Python versions to run tests with.'
30+
required: true
31+
type: string
32+
wheel:
33+
description: "Wheel package as input artifact."
34+
required: false
35+
default: ''
36+
type: string
37+
requirements:
38+
description: 'Python dependencies to be installed through pip.'
39+
required: false
40+
default: '-r tests/requirements.txt'
41+
type: string
42+
pacboy:
43+
description: 'MSYS2 dependencies to be installed through pacboy (pacman).'
44+
required: false
45+
default: ""
46+
type: string
47+
mingw_requirements:
48+
description: 'Override Python dependencies to be installed through pip on MSYS2 (MINGW64) only.'
49+
required: false
50+
default: ''
51+
type: string
52+
root_directory:
53+
description: 'Working directory for running tests.'
54+
required: false
55+
default: ''
56+
type: string
57+
tests_directory:
58+
description: 'Path to the directory containing tests (relative to root_directory).'
59+
required: false
60+
default: 'tests'
61+
type: string
62+
apptest_directory:
63+
description: 'Path to the directory containing application tests (relative to tests_directory).'
64+
required: false
65+
default: 'app'
66+
type: string
67+
apptest_xml_artifact:
68+
description: "Generate application test report with junitxml and upload results as an artifact."
69+
required: false
70+
default: ''
71+
type: string
72+
73+
jobs:
74+
ApplicationTesting:
75+
name: ${{ matrix.sysicon }} ${{ matrix.pyicon }} Application Tests using Python ${{ matrix.python }}
76+
runs-on: ${{ matrix.runs-on }}
77+
78+
strategy:
79+
fail-fast: false
80+
matrix:
81+
include: ${{ fromJson(inputs.jobs) }}
82+
83+
defaults:
84+
run:
85+
shell: ${{ matrix.shell }}
86+
87+
steps:
88+
- name: ⏬ Checkout repository
89+
uses: actions/checkout@v4
90+
91+
- name: 📥 Download artifacts '${{ inputs.wheel }}' from 'Package' job
92+
uses: actions/download-artifact@v4
93+
with:
94+
name: ${{ inputs.wheel }}
95+
path: install
96+
97+
- name: Compute pacman/pacboy packages
98+
id: pacboy
99+
if: matrix.system == 'msys2'
100+
shell: python
101+
run: |
102+
from os import getenv
103+
from pathlib import Path
104+
from re import compile
105+
from sys import version
106+
107+
print(f"Python: {version}")
108+
109+
def loadRequirementsFile(requirementsFile: Path):
110+
requirements = []
111+
with requirementsFile.open("r") as file:
112+
for line in file.readlines():
113+
line = line.strip()
114+
if line.startswith("#") or line.startswith("https") or line == "":
115+
continue
116+
elif line.startswith("-r"):
117+
# Remove the first word/argument (-r)
118+
requirements += loadRequirementsFile(requirementsFile.parent / line[2:].lstrip())
119+
else:
120+
requirements.append(line)
121+
122+
return requirements
123+
124+
requirements = "${{ inputs.requirements }}"
125+
if requirements.startswith("-r"):
126+
requirementsFile = Path(requirements[2:].lstrip())
127+
dependencies = loadRequirementsFile(requirementsFile)
128+
else:
129+
dependencies = [req.strip() for req in requirements.split(" ")]
130+
131+
packages = {
132+
"coverage": "python-coverage:p",
133+
"igraph": "igraph:p",
134+
"jinja2": "python-markupsafe:p",
135+
"lxml": "python-lxml:p",
136+
"numpy": "python-numpy:p",
137+
"markupsafe": "python-markupsafe:p",
138+
"pip": "python-pip:p",
139+
"ruamel.yaml": "python-ruamel-yaml:p python-ruamel.yaml.clib:p",
140+
"sphinx": "python-markupsafe:p",
141+
"tomli": "python-tomli:p",
142+
"wheel": "python-wheel:p",
143+
}
144+
subPackages = {
145+
"pytooling": {
146+
"yaml": "python-ruamel-yaml:p python-ruamel.yaml.clib:p",
147+
}
148+
}
149+
150+
regExp = compile(r"(?P<PackageName>[\w_\-\.]+)(?:\[(?P<SubPackages>(?:\w+)(?:\s*,\s*\w+)*)\])?(?:\s*(?P<Comperator>[<>~=]+)\s*)(?P<Version>\d+(?:\.\d+)*)(?:-(?P<VersionExtension>\w+))?")
151+
152+
pacboyPackages = set(("python-pip:p", "python-wheel:p", "python-tomli:p"))
153+
print(f"Processing dependencies ({len(dependencies)}):")
154+
for dependency in dependencies:
155+
print(f" {dependency}")
156+
157+
match = regExp.match(dependency.lower())
158+
if not match:
159+
print(f" Wrong format: {dependency}")
160+
print(f"::error title=Identifying Pacboy Packages::Unrecognized dependency format '{dependency}'")
161+
continue
162+
163+
package = match["PackageName"]
164+
if package in packages:
165+
rewrite = packages[package]
166+
print(f" Found rewrite rule for '{package}': {rewrite}")
167+
pacboyPackages.add(rewrite)
168+
169+
if match["SubPackages"] and package in subPackages:
170+
for subPackage in match["SubPackages"].split(","):
171+
if subPackage in subPackages[package]:
172+
rewrite = subPackages[package][subPackage]
173+
print(f" Found rewrite rule for '{package}[..., {subPackage}, ...]': {rewrite}")
174+
pacboyPackages.add(rewrite)
175+
176+
# Write jobs to special file
177+
github_output = Path(getenv("GITHUB_OUTPUT"))
178+
print(f"GITHUB_OUTPUT: {github_output}")
179+
with github_output.open("a+") as f:
180+
f.write(f"pacboy_packages={' '.join(pacboyPackages)}\n")
181+
182+
- name: '🟦 Setup MSYS2 for ${{ matrix.runtime }}'
183+
if: matrix.system == 'msys2'
184+
uses: msys2/setup-msys2@v2
185+
with:
186+
msystem: ${{ matrix.runtime }}
187+
update: true
188+
pacboy: >-
189+
${{ steps.pacboy.outputs.pacboy_packages }}
190+
${{ inputs.pacboy }}
191+
192+
- name: 🐍 Setup Python ${{ matrix.python }}
193+
if: matrix.system != 'msys2'
194+
uses: actions/setup-python@v5
195+
with:
196+
python-version: ${{ matrix.python }}
197+
198+
- name: 🔧 Install wheel and pip dependencies (native)
199+
if: matrix.system != 'msys2'
200+
run: |
201+
python -m pip install --disable-pip-version-check -U wheel
202+
python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
203+
204+
- name: 🔧 Install pip dependencies (MSYS2)
205+
if: matrix.system == 'msys2'
206+
run: |
207+
if [ -n '${{ inputs.mingw_requirements }}' ]; then
208+
python -m pip install --disable-pip-version-check ${{ inputs.mingw_requirements }}
209+
else
210+
python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
211+
fi
212+
213+
- name: 🔧 Install wheel from artifact
214+
run: |
215+
ls -l install
216+
python -m pip install --disable-pip-version-check -U install/*.whl
217+
218+
- name: ☑ Run application tests (Ubuntu/macOS)
219+
if: matrix.system != 'windows'
220+
run: |
221+
export ENVIRONMENT_NAME="${{ matrix.envname }}"
222+
223+
cd "${{ inputs.root_directory || '.' }}"
224+
[ -n '${{ inputs.apptest_xml_artifact }}' ] && PYTEST_ARGS='--junitxml=report/unit/TestReportSummary.xml' || unset PYTEST_ARGS
225+
if [ -n '${{ inputs.coverage_config }}' ]; then
226+
echo "coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
227+
coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}
228+
else
229+
echo "python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
230+
python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}
231+
fi
232+
233+
- name: ☑ Run application tests (Windows)
234+
if: matrix.system == 'windows'
235+
run: |
236+
$env:ENVIRONMENT_NAME = "${{ matrix.envname }}"
237+
238+
cd "${{ inputs.root_directory || '.' }}"
239+
$PYTEST_ARGS = if ("${{ inputs.apptest_xml_artifact }}") { "--junitxml=report/unit/TestReportSummary.xml" } else { "" }
240+
if ("${{ inputs.coverage_config }}") {
241+
Write-Host "coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
242+
coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}
243+
} else {
244+
Write-Host "python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
245+
python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}
246+
}
247+
248+
- name: 📤 Upload 'TestReportSummary.xml' artifact
249+
if: inputs.apptest_xml_artifact != ''
250+
uses: actions/upload-artifact@v4
251+
with:
252+
name: ${{ inputs.apptest_xml_artifact }}-${{ matrix.system }}-${{ matrix.runtime }}-${{ matrix.python }}
253+
path: report/unit/TestReportSummary.xml
254+
if-no-files-found: error
255+
retention-days: 1

‎.github/workflows/ArtifactCleanUp.yml

+5-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Unai Martinez-Corral #
55
# #
66
# ==================================================================================================================== #
7-
# Copyright 2020-2022 The pyTooling Authors #
7+
# Copyright 2020-2024 The pyTooling Authors #
88
# #
99
# Licensed under the Apache License, Version 2.0 (the "License"); #
1010
# you may not use this file except in compliance with the License. #
@@ -45,12 +45,14 @@ jobs:
4545

4646
- name: 🗑️ Delete package Artifacts
4747
if: ${{ ! startsWith(github.ref, 'refs/tags') }}
48-
uses: geekyeggo/delete-artifact@v2
48+
uses: geekyeggo/delete-artifact@v4
4949
with:
5050
name: ${{ inputs.package }}
51+
token: ${{ secrets.GITHUB_TOKEN }}
5152

5253
- name: 🗑️ Delete remaining Artifacts
5354
if: ${{ inputs.remaining != '' }}
54-
uses: geekyeggo/delete-artifact@v2
55+
uses: geekyeggo/delete-artifact@v4
5556
with:
5657
name: ${{ inputs.remaining }}
58+
token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/BuildTheDocs.yml

+20-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# Unai Martinez-Corral #
55
# #
66
# ==================================================================================================================== #
7-
# Copyright 2020-2022 The pyTooling Authors #
7+
# Copyright 2020-2024 The pyTooling Authors #
88
# #
99
# Licensed under the Apache License, Version 2.0 (the "License"); #
1010
# you may not use this file except in compliance with the License. #
@@ -27,27 +27,42 @@ on:
2727
inputs:
2828
artifact:
2929
description: 'Name of the documentation artifact.'
30-
required: true
30+
required: false
31+
default: ''
3132
type: string
3233

3334
jobs:
34-
3535
BuildTheDocs:
3636
name: 📓 Run BuildTheDocs
3737
runs-on: ubuntu-latest
3838

3939
steps:
4040
- name: ⏬ Checkout repository
41-
uses: actions/checkout@v3
41+
uses: actions/checkout@v4
4242

4343
- name: 🛳️ Build documentation
4444
uses: buildthedocs/btd@v0
4545
with:
4646
skip-deploy: true
4747

4848
- name: 📤 Upload 'documentation' artifacts
49-
uses: actions/upload-artifact@v3
49+
if: inputs.artifact != ''
50+
uses: actions/upload-artifact@v4
5051
with:
5152
name: ${{ inputs.artifact }}
5253
path: doc/_build/html
5354
retention-days: 1
55+
56+
- name: '📓 Publish site to GitHub Pages'
57+
if: inputs.artifact == '' && github.event_name != 'pull_request'
58+
run: |
59+
cp --recursive -T doc/_build/html public
60+
cd public
61+
touch .nojekyll
62+
git init
63+
cp ../.git/config ./.git/config
64+
git add .
65+
git config --local user.email "BuildTheDocs@GitHubActions"
66+
git config --local user.name "GitHub Actions"
67+
git commit -a -m "update ${{ github.sha }}"
68+
git push -u origin +HEAD:gh-pages

0 commit comments

Comments
 (0)