Rewrite project build and metadata using pyproject.toml (#88)

This patch rewrites the project build configuration using pyproject.toml,
which is now the de-facto standard in Python. This single configuration
file supersedes setup.py, tox.ini, mypy.ini, etc.

I checked the contents of the generated package and made sure they matched
exactly (that caught a few issues where I originally excluded some data
files).

This patch is careful not to change the version of dependencies. In
pyproject.toml, we specify minimum package versions for the tool to
work, and we provide a requirements.txt file that pins down specific
versions for use by end-users.

Currently, a few tests are failing if we don't pin exact versions when
running them, so we're still pinning exact versions when we run tests
via tox. The same holds for the type checker.

In the future, we could upgrade towards a proper lockfile instead of
manually constructed requirements.txt files.

Fixes #77

Author: ldionne

Dockerfile

@@ -4,19 +4,14 @@ RUN apk update \
   && apk add --no-cache --virtual .build-deps git g++ postgresql-dev yaml-dev \
   && apk add --no-cache libpq
 
-WORKDIR /var/src/lnt
+COPY . /var/src/lnt
 
-COPY requirements*.txt setup.py .
-# setup.py uses lnt.__version__ etc.
-COPY lnt/__init__.py lnt/__init__.py
-# we build the cperf extension during install
-COPY lnt/testing/profile lnt/testing/profile
+WORKDIR /var/src/lnt
 
 RUN pip3 install -r requirements.server.txt \
   && apk --purge del .build-deps \
   && mkdir /var/log/lnt
 
-COPY . .
 COPY docker/docker-entrypoint.sh docker/wait_db /usr/local/bin/
 
 VOLUME /var/log

docs/developer_guide.rst

@@ -34,10 +34,8 @@ To run the tests, we recomment using ``tox`` in a virtual environment::
 
 You can also run individual unit tests with ``lit`` directly::
 
-    pip install lit
-    lit -sv ./tests
-
-However, that requires manually setting up the testing environment (``filecheck``, etc).
+    pip install ".[dev]"
+    lit -sv tests
 
 For simple changes, adding a regression test and making sure all regression
 tests pass, is often a good enough testing approach. For some changes, the

mypy.ini

@@ -0,0 +1,154 @@
+[build-system]
+requires = ["setuptools >= 74.1"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "LNT"
+version = "0.4.2.dev0"
+description = "LLVM Nightly Test Infrastructure"
+readme = "README.md"
+license = "LicenseRef-Apache-2.0-with-LLVM-exception"
+license-files = ["LICENSE.TXT"]
+authors = [
+    { name = "Daniel Dunbar", email = "[email protected]" },
+]
+maintainers = []
+keywords = ["web", "testing", "performance", "development", "llvm"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Testing",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "aniso8601>=1.2.0",
+    "certifi",
+    "click>=8.1.0",
+    "Flask-RESTful>=0.3.10",
+    "Flask-WTF>=1.2.0",
+    "Flask>=3.1.0",
+    "Jinja2>=3.1.0",
+    "MarkupSafe>=3.0.0",
+    "python-gnupg>=0.3.7",
+    "PyYAML>=6.0.0",
+    "requests",
+    "SQLAlchemy==1.3.24",
+    "typing",
+    "Werkzeug>=3.1.0",
+    "WTForms>=3.2.0",
+]
+
+[project.urls]
+Homepage = "https://llvm.org"
+Documentation = "https://llvm.org/docs/lnt"
+Repository = "https://github.com/llvm/llvm-lnt"
+"Bug Reports" = "https://github.com/llvm/llvm-lnt/issues"
+
+[project.scripts]
+lnt = "lnt.lnttool:main"
+
+[project.optional-dependencies]
+server = [
+    "gunicorn>=19.9.0",
+    "psycopg2>=2.9.0",
+]
+dev = [
+    "filecheck",
+    "Flake8-pyproject",
+    "flake8",
+    "lit",
+    "tox",
+]
+
+[tool.setuptools]
+ext-modules = [
+    {name = "lnt.testing.profile.cPerf", sources = ["lnt/testing/profile/cPerf.cpp"]}
+]
+
+[tool.setuptools.packages]
+find = {namespaces = false}
+
+[tool.setuptools.package-data]
+"lnt.server.ui" = [
+    "static/*.ico",
+    "static/*.js",
+    "static/*.css",
+    "static/*.svg",
+    "static/bootstrap/css/*.css",
+    "static/bootstrap/js/*.js",
+    "static/bootstrap/img/*.png",
+    "static/flot/*.min.js",
+    "static/plotly/*.min.js",
+    "static/d3/*.min.js",
+    "static/jquery/**/*.min.js",
+    "templates/*.html",
+    "templates/reporting/*.html",
+    "templates/reporting/*.txt",
+]
+"lnt.server.db" = [
+    "migrations/*.py"
+]
+
+[tool.flake8]
+ignore = ["E712", "E402", "E711", "E266", "W605", "E126", "E226", "W504"]
+max-line-length = 120
+count = true
+
+[tool.mypy]
+plugins = ["sqlmypy"]
+
+[tool.tox]
+env_list = ["py3", "mypy", "flake8", "docs"]
+
+[tool.tox.env.py3]
+description = "Run the unit tests"
+allowlist_externals = ["rm", "lit"]
+# TODO: Make it possible to run the tests without pinning down all dependencies
+deps = [
+    "-r requirements.txt",
+    ".[dev]",
+]
+commands = [
+    ["rm", "-rf", "test_run_tmp"],
+    ["lit", "-sv", "tests"],
+]
+
+[tool.tox.env.flake8]
+description = "Run linter on the codebase"
+deps = [".[dev]"]
+commands = [["flake8", "--statistics", "--exclude=./lnt/external/", "./lnt/", "./tests/", "./deployment/"]]
+skip_install = true
+
+[tool.tox.env.mypy]
+description = "Typecheck the codebase"
+# TODO: Make it possible to install [.dev] dependencies instead
+deps = [
+    "mypy >= 0.910",
+    "sqlalchemy-stubs",
+    "types-certifi",
+    "types-PyYAML",
+]
+# The option --no-incremental is currently needed to suppress warnings
+# about UpdatedBase when running tests several times. Future versions of
+# mypy should be checked to see if it can be removed and not get
+# warnings after running tox several times.
+commands = [["mypy", "--no-incremental", "--ignore-missing-imports", "lnt"]]
+skip_install = true
+
+[tool.tox.env.docs]
+description = "Build the documentation"
+deps = [
+    "sphinx==7",
+    "sphinx_bootstrap_theme",
+]
+allowlist_externals = ["make"]
+commands = [["make", "-C", "{toxinidir}/docs/", "html"]]
+skip_install = true