opendev/engagement
Code Issues Proposed changes

Update project boilerplate

Browse Source 
Switch from tox to nox, use updated pyproject packaging standards,
add placeholder testing for future expansion.

Change-Id: I51c0b0d345af88659b7d84730b5bbe42b92c240b
This commit is contained in:
Jeremy Stanley 2025-03-20 17:36:26 +00:00
parent 864007eaec
commit 87ca6bc531
15 changed files with 412 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.coveragerc Normal file
View File

@ -0,0 +1,6 @@
[run]
branch = True
source = engagement
[report]
ignore_errors = True

6
.flake8 Normal file
View File

@ -0,0 +1,6 @@
[flake8]
# E123, E125 skipped as they are invalid PEP-8.
show-source = True
ignore = E123,E125,E126,E129,E226,H,W503,W504,W605
builtins = _
exclude=.venv,.git,.nox,.tox,dist,doc,*lib/python*,*egg,build

1
.gitignore vendored
View File

@ -37,6 +37,7 @@ pip-log.txt
cover/
.coverage*
!.coveragerc
.nox
.tox
nosetests.xml
.testrepository

3
.stestr.conf Normal file
View File

@ -0,0 +1,3 @@
[DEFAULT]
test_path=engagement/tests
top_dir=./

10
.zuul.yaml
View File

@ -1,9 +1,13 @@
- project:
templates:
- publish-opendev-tox-docs
- publish-opendev-nox-docs
check:
jobs:
- tox-linters
- nox-linters
- nox-py312:
nodeset: ubuntu-noble
gate:
jobs:
- tox-linters
- nox-linters
- nox-py312:
nodeset: ubuntu-noble

42
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,42 @@
Contribution Overview
=====================
OpenDev's tools are hosted within the OpenDev collaboratory, and
development for them uses workflows described in the OpenDev
Infrastructure Manual:
http://docs.opendev.org/opendev/manual/developers.html
Defect reporting and task tracking takes place here:
https://storyboard.openstack.org/#!/project/opendev/engagement
Developing engagement
=====================
Running Tests
-------------
The testing system is based on a combination of nox and testr. The canonical
approach to running tests is to simply run the command `nox`. This will
create virtual environments, populate them with dependencies and run all of
the tests that OpenStack CI systems run. Behind the scenes, nox is running
`testr run --parallel`, but is set up such that you can supply any additional
testr arguments that are needed to nox. For example, you can run:
`nox -- --analyze-isolation` to cause nox to tell testr to add
--analyze-isolation to its argument list.
It is also possible to run the tests inside of a virtual environment
you have created, or it is possible that you have all of the dependencies
installed locally already. If you'd like to go this route, the requirements
are listed in pyproject.toml and the requirements for testing are in package
extras defined with project.optional-dependencies entries. Installing them
via pip, for instance, is simply::
pip install -e '.[test-unit]'
In you go this route, you can interact with the testr command directly.
Running `testr run` will run the entire test suite. `testr run --parallel`
will run it in parallel (this is the default incantation nox uses.) More
information about testr can be found at:
https://testrepository.readthedocs.io/en/latest/

176
LICENSE Normal file
View File

@ -0,0 +1,176 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

22
engagement/tests/__init__.py Normal file
View File

@ -0,0 +1,22 @@
# Copyright OpenDev Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from testtools import TestCase
class TestMain(TestCase):
def test_placeholder(self):
...

63
noxfile.py Normal file
View File

@ -0,0 +1,63 @@
import nox
nox.options.error_on_external_run = True
nox.options.reuse_existing_virtualenvs = True
nox.options.sessions = ["tests-3", "linters"]
# Convenience wrapper for stats generation
@nox.session(python="3")
def stats(session):
session.install(".")
session.run("engagement-stats", *session.posargs)
# Note setting python this way seems to give us a target name without
# python specific suffixes while still allowing us to force a specific
# version using --force-python.
@nox.session(python="3")
def linters(session):
# TODO: switch this line to 'session.install("--group", "test-linters")'
session.install(".[test-linters]")
session.run("flake8")
@nox.session(python="3")
def docs(session):
# TODO: switch this line to 'session.install("--group", "build-docs")'
session.install(".[build-docs]")
session.run(
"sphinx-build", "-W",
"-d", "doc/build/doctrees",
"-b", "html",
"doc/source/", "doc/build/html"
)
@nox.session(python="3")
def venv(session):
# TODO: switch to 'session.install("-e", ".", "--group", "test-unit")'
session.install("-e", ".[test-unit]")
session.run(*session.posargs)
# This will attempt to run python3 tests by default.
@nox.session(python=["3"])
def tests(session):
# TODO: switch to 'session.install("-e", ".", "--group", "test-unit")'
session.install("-e", ".[test-unit]")
session.run("stestr", "run", *session.posargs)
session.run("stestr", "slowest")
@nox.session(python="3")
def cover(session):
# TODO: switch to 'session.install("-e", ".", "--group", "test-cover")'
session.install("-e", ".[test-cover]")
session.env["PYTHON"] = "coverage run --source engagement --parallel-mode"
session.run("stestr", "run", *session.posargs)
session.run("stestr", "slowest")
session.run("coverage", "combine")
session.run("coverage", "html", "-d", "cover")
session.run("coverage", "xml", "-o", "cover/coverage.xml")

84
pyproject.toml
View File

@ -1,3 +1,85 @@
[build-system]
requires = ["pbr>=5.8.0", "setuptools>=36.6.0", "wheel"]
requires = ["pbr>=6.1.1"]
build-backend = "pbr.build"
[project]
authors = [
{email = "service-discuss@lists.opendev.org"},
{name = "OpenDev Contributors"},
]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"Operating System :: MacOS :: MacOS X",
"Operating System :: POSIX :: Linux",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: Implementation :: CPython",
"Topic :: Software Development :: Quality Assurance",
"Topic :: Software Development :: Testing",
"Topic :: Utilities",
]
dependencies = [
"pyyaml",
"requests",
]
description = "Engagement statistics for OpenDev services"
dynamic = ["version"]
keywords = [
"contributor",
"statistics",
]
license = "Apache-2.0"
maintainers = [
{email = "service-discuss@lists.opendev.org"},
{name = "OpenDev Contributors"},
]
name = "opendev-engagement"
readme = {charset = "UTF-8", content-type = "text/x-rst", file = "README.rst"}
requires-python = ">=3.7"
# TODO: replace this with '[dependency-groups]' once pip 25.1 is released
[project.optional-dependencies]
build-docs = [
"fixtures>=0.3.12",
"reno>=2.8.0",
"sphinx!=1.6.6,!=1.6.7,!=2.1.0",
"sphinxcontrib-programoutput",
]
test-cover = [
# TODO: in a depgroup switch this line to '{include-group = "test-unit"},'
"opendev-engagement[test-unit]",
"coverage>=3.6",
]
test-linters = [
"hacking>=7,<8"
]
test-unit = [
"fixtures>=0.3.12",
"python-subunit",
"stestr>=1.0.0",
"testtools>=0.9.27",
]
[project.scripts]
engagement-stats = "engagement.stats:main"
[project.urls]
"Browse Source" = "https://opendev.org/opendev/engagement"
"Bug Reporting" = "https://storyboard.openstack.org/#!/project/opendev/engagement"
"Documentation" = "https://docs.opendev.org/opendev/engagement"
"Git Clone URL" = "https://opendev.org/opendev/engagement"
"License Texts" = "https://opendev.org/opendev/engagement/src/branch/master/LICENSE"
"Release Notes" = "https://docs.opendev.org/opendev/engagement/latest/releasenotes.html"
[tool.setuptools]
# This tells SetupTools to ignore the reports directory.
packages = ["engagement"]

2
requirements.txt
View File

@ -1,2 +0,0 @@
pyyaml
requests

43
setup.cfg
View File

@ -1,44 +1,3 @@
# TODO: Delete this file once PBR can read project names from pyproject.toml
[metadata]
name = opendev-engagement
summary = Engagement statistics for OpenDev services
long_description = file: README.rst
long_description_content_type = text/x-rst; charset=UTF-8
author = OpenDev Contributors
author_email = service-discuss@lists.opendev.org
url = https://docs.opendev.org/opendev/engagement/
project_urls =
Browse Source = https://opendev.org/opendev/engagement
Bug Reporting = https://storyboard.openstack.org/#!/project/opendev/engagement
Documentation = https://docs.opendev.org/opendev/engagement/
Git Clone URL = https://opendev.org/opendev/engagement
License Texts = https://opendev.org/opendev/engagement/src/branch/master/LICENSE
keywords = contributor statistics
license = Apache License, Version 2.0
platforms = POSIX/Unix
classifier =
Development Status :: 5 - Production/Stable
Environment :: Console
Intended Audience :: Developers
Intended Audience :: Information Technology
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python :: 3
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: Implementation :: CPython
Topic :: Software Development :: Testing
Topic :: Utilities
[options]
python_requires = >=3.6
[files]
packages =
engagement
[entry_points]
console_scripts =
engagement-stats = engagement.stats:main

2
setup.py
View File

@ -14,6 +14,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# TODO: Delete this file once PBR gains the ability to act as a build hook
import setuptools
setuptools.setup(pbr=True)

1
test-requirements.txt
View File

@ -1 +0,0 @@
flake8

29
tox.ini
View File

@ -1,29 +0,0 @@
[tox]
minversion = 3.1
envlist = linters, py3
ignore_basepython_conflict = True
[testenv]
basepython = python3
deps = -r{toxinidir}/test-requirements.txt
# TODO(fungi): work out a representative replay call with a suitable but
# small test payload and target results comparison
commands =
python setup.py test --slowest --testr-args='{posargs}'
[testenv:linters]
commands = flake8
[testenv:docs]
allowlist_externals = rm
deps = -r{toxinidir}/doc/requirements.txt
commands =
rm -fr doc/build
sphinx-build -W -b html doc/source doc/build/html
[testenv:stats]
commands = engagement-stats {posargs}
[flake8]
show-source = True
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build