Simplify CI, add coverage, black, and rules

Author: haydenbaker

.github/workflows/ci.yml

@@ -1,115 +1,46 @@
 name: CI
 
 on:
-    push:
-        branches:
-          - develop
     pull_request:
         branches:
           - develop
 
 jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.12"]
-
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Python for CI - ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Initialize Pants
-        uses: pantsbuild/actions/init-pants@main
-        with:
-          # cache0 makes it easy to bust the cache if needed
-          # just increase the integer to start with a fresh cache
-          gha-cache-key: cache0-py${{ matrix.python_version }}
-          named-caches-hash: ${{ hashFiles('python-default.lock') }}
-          pants-ci-config: pants.ci.toml
-
-      - name: Run tests
-        run: |
-          make test-py
-
-      - name: Upload coverage
-        if: matrix.python-version == 3.12
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          file: ./dist/coverage/python/coverage.xml
-          flags: unittests
-          name: codecov-umbrella
-          fail_ci_if_error: true
-
-
-  test-codegen:
+  ci:
     runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.12"]
-
-    name: Codegen Java 17 / Python ${{ matrix.python-version }}
-
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Download Corretto 17 JDK
-        run: |
-          download_url="https://corretto.aws/downloads/latest/amazon-corretto-17-x64-linux-jdk.tar.gz"
-          wget -O $RUNNER_TEMP/java_package.tar.gz $download_url
-
-      - name: Set up Corretto 17 JDK
+      - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
-          distribution: 'jdkfile'
-          jdkFile: ${{ runner.temp }}/java_package.tar.gz
           java-version: 17
-          architecture: x64
+          distribution: 'corretto'
 
-      - name: clean and build without python
-        run: cd codegen && ./gradlew clean build
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
 
-      - name: Set Up Python for CI - ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Initialize Pants
-        uses: pantsbuild/actions/init-pants@main
-        with:
-          # cache0 makes it easy to bust the cache if needed
-          gha-cache-key: cache0-py${{ matrix.python_version }}
-          named-caches-hash: ${{ hashFiles('python-default.lock') }}
-          pants-ci-config: pants.ci.toml
-
-      - name: Install smithy-python
+      - name: Setup workspace
         run: |
-          make install-python-components
+          make install
 
-      - name: clean and build without formatting/linting installed
-        run: cd codegen && ./gradlew clean build
+      - name: Check python packages
+        run: |
+          make check-py
 
-      - name: Install black
+      - name: Test python packages
         run: |
-          python${{ matrix.python-version }} -m pip install --upgrade black
+          make test-py
 
-      - name: clean and build without linting installed
-        run: cd codegen && ./gradlew clean build
+      - name: Build python packages
+        run: |
+          make build-py
 
-      - name: Install mypy and other libraries necessary for typing
+      - name: Build (and test) java packages
         run: |
-          python${{ matrix.python-version }} -m pip install --upgrade mypy pytest pytest-asyncio
+          make build-java
 
-      - name: clean and build with all optional tools installed
-        run: cd codegen && ./gradlew clean build
+      - name: Run protocol tests
+        run: |
+          make test-protocols

.github/workflows/lint.yml

@@ -18,23 +18,23 @@ test-protocols: ## Generates and runs the restJson1 protocol tests.
 	uv run pytest codegen/protocol-test/build/smithyprojections/protocol-test/rest-json-1/python-client-codegen
 
 
-lint-py: ## Runs formatters/fixers/linters for the python packages.
-	uv run docformatter --wrap-summaries 88 --wrap-description 88 packages -r -i || true
+lint-py: ## Runs linters and formatters on the python packages.
+	uv run docformatter packages --in-place || true
 	uv run ruff check packages --fix
 	uv run ruff format packages
 
 
-check-py: ## Runs checkers for the python packages.
+check-py: ## Runs checks (formatting, lints, type-checking) on the python packages.
+	uv run docformatter packages
 	uv run ruff check packages
 	uv run pyright packages
-	uv run bandit packages -r -x tests
 
 
 test-py: ## Runs tests for the python packages.
 	uv run pytest packages
 
 
-build-py: lint-py check-py test-py ## Builds (and lints, checks, and tests) the python packages.
+build-py: ## Builds the python packages.
 	uv build --all-packages 
 
 

.github/workflows/protocol-test.yml

@@ -8,11 +8,12 @@ dependencies = []
 
 [dependency-groups]
 dev = [
-    "bandit>=1.8.3",
+    "black>=25.1.0",
     "docformatter>=1.7.5",
     "pyright>=1.1.394",
     "pytest>=8.3.4",
     "pytest-asyncio>=0.25.3",
+    "pytest-cov>=6.0.0",
     "ruff>=0.9.7",
 ]
 
@@ -35,16 +36,26 @@ typeCheckingMode = "strict"
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto" # makes pytest run async tests without having to be marked with the @pytest.mark.asyncio decorator
-addopts = [ "--import-mode=importlib" ]
+addopts = [ "--import-mode=importlib", "--cov", "--cov-report=term-missing" ]
+
+[tool.docformatter]
+recursive = true
+black = true
 
 [tool.ruff]
 target-version = "py312"
 
 [tool.ruff.lint]
-# select = ["ASYNC", "F", "FURB", "G", "I", "LOG", "N", "Q", "T"]
-# candidates: C4, DTZ, EM, INP, ISC, PERF, PIE, RUF, SIM118, SIM401, SLOT, T20, UP, W
-# perhaps in the future: CPY, N, PYI, TC, TID
+# candidates: C4, DTZ, EM, INP, ISC, PERF, PIE, RUF, SIM118, SIM401, SLOT
+# perhaps in the future: N, PYI, TC, TID
 # probably not, a lot of work: DOC, D, PL, TRY
 
+# TODO: I, T, UP
+select = [ "ASYNC", "E1", "E4", "E7", "E9", "F", "FURB", "G", "LOG", "S" ]
+exclude = [ "packages/smithy-core/src/smithy_core/rfc3986.py" ]
+
+[tool.ruff.lint.per-file-ignores]
+"**/{tests}/*" = ["S"]
+
 [tool.ruff.format]
 docstring-code-format = true