feat: update build system (#15)

* feat: update build system * chore: linting * feat: update CI
kuisathaverat · Feb 16, 2024 · 57aa70e · 57aa70e
1 parent ff8b459
commit 57aa70e
Show file tree

Hide file tree

Showing 20 changed files with 274 additions and 314 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -12,30 +12,6 @@ insert_final_newline = true
 [*.asciidoc]
 trim_trailing_whitespace = false
 
-[Jenkinsfile]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.groovy]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.dsl]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
 [{Makefile,**.mk}]
 # Use tabs for indentation (Makefiles require tabs)
 indent_style = tab
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -24,13 +24,15 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version-file: .python-version
-          cache: 'pip'
-          cache-dependency-path: requirements.txt
+          cache-dependency-path: pyproject.toml
       - name: Lint
         run: make lint
-  build:
+  test-python:
     runs-on: ubuntu-latest
     needs: lint
+    strategy:
+      matrix:
+        python-version: [3.8, 3.9, 3.10, 3.11, 3.12]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -40,16 +42,15 @@ jobs:
           ref: ${{ github.sha || 'main' }}
       - uses: actions/setup-python@v5
         with:
-          python-version-file: .python-version
-          cache: 'pip'
-          cache-dependency-path: requirements.txt
+          python-version-file: ${{ matrix.python-version }}
+          cache-dependency-path: pyproject.toml
       - name: test
         run: make test
       - name: it-test
         run: make it-test
   release:
     runs-on: ubuntu-latest
-    needs: [lint, build]
+    needs: [lint, test-python]
     permissions:
       # write permission is required to create a github release
       contents: write
@@ -60,16 +61,39 @@ jobs:
           fetch-depth: 0
           fetch-tags: false
           ref: ${{ github.sha || 'main' }}
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version
+          cache-dependency-path: pyproject.toml
+
+      - name: Check version change
+        uses: actions/github-script@v7
+        id: check_version
+        with:
+          script: |
+            const fs = require('fs');
+            const version = fs.readFileSync('src/pytest_otel/__init__.py', 'utf8').match(/__version__ = (.*)/)[1].trim();
+            const { data: latestRelease } = await github.rest.repos.getLatestRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+            })
+
+            if (latestRelease.tag_name === version) {
+              core.setOutput('release', 'false' );
+            } else {
+              core.setOutput('release', 'true' );
+              core.setOutput('version', version );
+            }
       - name: Release
+        if: ${{ steps.check_version.outputs.release == 'true'}}
         id: release
-        run: |
-          make publish
-          grep "version = " setup.cfg | tr -d " " >> ${GITHUB_OUTPUT}
+        run: make publish
         env:
           TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
           REPO_URL: ${{ secrets.REPO_URL }}
       - uses: release-drafter/release-drafter@v6
+        if: ${{ steps.check_version.outputs.release == 'true'}}
         with:
           version: ${{ steps.release.outputs.version }}
           publish: true

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,11 +21,10 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version-file: .python-version
-          cache: 'pip'
-          cache-dependency-path: requirements.txt
+          cache-dependency-path: pyproject.toml
       - name: Lint
         run: make lint
-  build:
+  test:
     runs-on: ubuntu-latest
     needs: lint
     steps:
@@ -38,8 +37,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version-file: .python-version
-          cache: 'pip'
-          cache-dependency-path: requirements.txt
+          cache-dependency-path: pyproject.toml
       - name: test
         run: make test
       - name: it-test

diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,6 @@ junit-test_*.xml
 .mypy_cache
 .pytest_cache
 tests/tests.json
+dist
+.coverage.*
+.coverage
diff --git a/Makefile b/Makefile
@@ -6,33 +6,11 @@ OTEL_SERVICE_NAME ?= "pytest_otel_test"
 OTEL_EXPORTER_OTLP_INSECURE ?= True
 OTEL_EXPORTER_OTLP_HEADERS ?=
 TRACEPARENT ?=
-REPO_URL ?= https://upload.pypi.org/legacy/
 DEMO_DIR ?= docs/demos
 
 VENV ?= .venv
 PYTHON ?= python3
 PIP ?= pip3
-GH_VERSION = 1.0.0
-
-UNAME_S := $(shell uname -s)
-ifeq ($(UNAME_S),Linux)
-	OS_FLAG := linux
-endif
-ifeq ($(UNAME_S),Darwin)
-	OS_FLAG := macOS
-endif
-UNAME_P := $(shell uname -m)
-ifeq ($(UNAME_P),x86_64)
-	ARCH_FLAG := amd64
-endif
-ifneq ($(filter %86,$(UNAME_P)),)
-	ARCH_FLAG := i386
-endif
-GH_BINARY = gh_$(GH_VERSION)_$(OS_FLAG)_$(ARCH_FLAG)
-GH = $(CURDIR)/bin/gh
-
-export UID=$(shell id -u)
-export GID=$(shell id -g)
 
 SHELL = /bin/bash
 .SILENT:
@@ -43,55 +21,44 @@ help:
 	@echo ""
 	@grep '^## @help' Makefile|cut -d ":" -f 2-3|( (sort|column -s ":" -t) || (sort|tr ":" "\t") || (tr ":" "\t"))
 
-bin:
-	mkdir bin
-
-bin/gh: bin
-	curl -sSfL https://github.com/cli/cli/releases/download/v$(GH_VERSION)/$(GH_BINARY).tar.gz|tar xz
-	mv $(GH_BINARY)/bin/gh bin/gh
-	rm -fr $(GH_BINARY)
-
 ## @help:virtualenv:Create a Python virtual environment.
 .PHONY: virtualenv
 virtualenv:
 	$(PYTHON) --version
 	test -d $(VENV) || $(PYTHON) -m venv $(VENV);\
-	source $(VENV)/bin/activate;\
-	$(PIP) install -q -r requirements.txt;
-
-## @help:install:Install APM CLI in a Python virtual environment.
-.PHONY: install
-install: virtualenv
-	source $(VENV)/bin/activate;\
-	$(PIP) install .;
+	source $(VENV)/bin/activate; \
+	$(PIP) install ".[test]";
 
 ## @help:test:Run the test.
 .PHONY: test
-test: virtualenv install
+test: virtualenv
 	source $(VENV)/bin/activate;\
-	pytest --capture=no -p pytester --runpytest=subprocess \
+	$(PYTHON) -m pytest --capture=no -p pytester --runpytest=subprocess \
 		--junitxml $(CURDIR)/junit-test_pytest_otel.xml \
 		tests/test_pytest_otel.py;
 
 ## @help:test:Run the test.
 .PHONY: test
-it-test: virtualenv install
+it-test: virtualenv
 	set -e;\
 	source $(VENV)/bin/activate;\
 	for test in tests/it/test_*.py; \
 	do \
-		pytest --capture=no -p pytester --runpytest=subprocess \
+		$(PYTHON) -m pytest --capture=no -p pytester --runpytest=subprocess \
 			--junitxml $(CURDIR)/junit-$$(basename $${test}).xml \
 			$${test}; \
 	done;
-	#pytest --capture=no -p pytester --runpytest=subprocess tests/it/test_*.py;
 
-## @help:coverage:Report coverage.
-.PHONY: coverage
-coverage: virtualenv
+## @help:format:Format the code.
+format: virtualenv
+	source $(VENV)/bin/activate;\
+	$(PYTHON) -m black src/pytest_otel tests;
+
+## @help:test-coverage:Report coverage.
+.PHONY: test-coverage
+test-coverage: virtualenv
 	source $(VENV)/bin/activate;\
-	coverage run --source=otel -m pytest; \
-	coverage report -m;
+	pytest --cov=pytest_otel --capture=no -p pytester --runpytest=subprocess tests/test_pytest_otel.py;
 
 ## @precomit:pre-commit:Run precommit hooks.
 lint: virtualenv
@@ -107,13 +74,12 @@ clean:
 	@find . -type f -name "*.py[co]" -delete
 	@find . -type d -name "__pycache__" -delete
 	@find . -name '*~' -delete
-	-@rm -fr src/pytest_otel.egg-info *.egg-info build dist $(VENV) bin .tox .mypy_cache .pytest_cache otel-traces-file-output.json test_spans.json temp junit-*.xml
+	-@rm -fr src/pytest_otel.egg-info *.egg-info build dist $(VENV) bin .tox .mypy_cache .pytest_cache otel-traces-file-output.json test_spans.json temp junit-*.xml .coverage*
 
-package: virtualenv
+## @help:build:Build the Python project package.
+build: virtualenv
 	source $(VENV)/bin/activate;\
-	set +xe; \
-	pip install wheel; \
-	$(PYTHON) setup.py sdist bdist_wheel
+	$(PYTHON) -m build
 
 ## @help:run-otel-collector:Run OpenTelemetry collector in debug mode.
 .PHONY: run-otel-collector
@@ -125,31 +91,28 @@ run-otel-collector:
 	--name otelcol otel/opentelemetry-collector \
 	--config otel-config.yaml; \
 
-#https://upload.pypi.org/legacy/
-#https://test.pypi.org/legacy/
-#secret/observability-team/ci/apm-agent-python-pypi-test
-#secret/observability-team/ci/apm-agent-python-pypi-prod
+# https://upload.pypi.org/legacy/
+# https://test.pypi.org/legacy/
 ## @help:publish REPO_URL=${REPO_URL} TWINE_USER=${TWINE_USER} TWINE_PASSWORD=${TWINE_PASSWORD}:Publish the Python project in a PyPI repository.
 .PHONY: publish
-publish: package
+publish: build
 	set +xe; \
 	source $(VENV)/bin/activate;\
-	$(PYTHON) -m pip install twine;\
-	echo "Uploading to $${REPO_URL} with user $${TWINE_USER}";\
-	python -m twine upload --username "$${TWINE_USER}" --password "$${TWINE_PASSWORD}" --skip-existing --repository-url $${REPO_URL} dist/*.tar.gz;\
-	python -m twine upload --username "$${TWINE_USER}" --password "$${TWINE_PASSWORD}" --skip-existing --repository-url $${REPO_URL} dist/*.whl
+	echo "Uploading to $${REPO_URL}";\
+	$(PYTHON) -m twine upload --username "$${TWINE_USER}" --password "$${TWINE_PASSWORD}" --skip-existing --repository-url $${REPO_URL} dist/*.tar.gz;\
+	$(PYTHON) -m twine upload --username "$${TWINE_USER}" --password "$${TWINE_PASSWORD}" --skip-existing --repository-url $${REPO_URL} dist/*.whl
 
 ## @help:demo-start-DEMO_NAME:Starts the demo from the demo folder, DEMO_NAME is the name of the demo type folder in the docs/demos folder (jaeger, elastic).
 .PHONY: demo-start-%
-demo-start-%: virtualenv install
+demo-start-%: virtualenv
 	$(MAKE) demo-stop-$*
 	mkdir -p $(DEMO_DIR)/$*/build
 	touch $(DEMO_DIR)/$*/build/tests.json
 	docker-compose -f $(DEMO_DIR)/$*/docker-compose.yml up -d
 	. $(DEMO_DIR)/$*/demo.env;\
 	env | grep OTEL;\
 	source $(VENV)/bin/activate;\
-	pytest --capture=no docs/demos/test/test_demo.py || echo "Demo execution finished you can access to http://localhost:5601 to check the traces, the user is 'admin' and the password 'changeme'";
+	$(PYTHON) -m pytest --capture=no docs/demos/test/test_demo.py || echo "Demo execution finished you can access to http://localhost:5601 to check the traces, the user is 'admin' and the password 'changeme'";
 
 ## @help:demo-stop-DEMO_NAME:Stops the demo from the demo folder, DEMO_NAME is the name of the demo type folder in the docs/demos folder (jaeger, elastic).
 .PHONY: demo-stop-%

diff --git a/mypy.ini b/mypy.ini