Merge pull request #1 from lestex/initial

adds code, workflows and tests

Author: lestex

.editorconfig

@@ -0,0 +1,27 @@
+# http://editorconfig.org
+
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Docstrings and comments use max_line_length = 79
+[*.py]
+max_line_length = 119
+
+# Makefiles always use tabs for indentation
+[Makefile]
+indent_style = tab
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+[*.{yaml,yml}]
+indent_size = 2

.github/workflows/lint.yml

@@ -0,0 +1,48 @@
+name: Lint
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - "**.py"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+        - '3.10'
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        pip install --upgrade pip setuptools wheel
+        pip install flake8==4.0.1
+        pip install --upgrade isort blue mypy types-PyYAML bandit safety
+
+    - name: Run lint
+      run: isort .
+
+    - name: Run blue formatter
+      run: make format
+
+    - name: Run flake8
+      run: |
+        flake8 . --count --show-source --statistics
+        flake8 . --count --exit-zero --max-complexity=4
+
+    - name: Run mypy / static types
+      run: make static-check
+
+    - name: Run bandit
+      run: bandit pygithubactions
+
+    - name: Run safety
+      run: safety check

.github/workflows/main.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - 'main'
+  push:
+    paths-ignore: [ 'docs/**', '*.md', '*.yaml', '*.yml', '*.toml' ]
+    branches:
+      - 'main'
+
+env:
+  GH_TOKEN: ${{ github.token }}
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+        - '3.10'
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install pytest pytest-cov
+          make install-local
+
+      - name: Run tests
+        run: make test

Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.10 as builder
+
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+RUN apt update && apt upgrade -y
+
+WORKDIR /app
+COPY . /app/
+
+# install app
+RUN pip install .
+
+ENV HOME="/home/nonadmin"
+RUN groupadd -r -g 1001 nonadmin && useradd -r -d $HOME -u 1001 -g nonadmin nonadmin
+RUN mkdir -p $HOME
+RUN chown nonadmin $HOME
+USER nonadmin
+
+CMD [ "python", "-V"]

Makefile

@@ -0,0 +1,88 @@
+.PHONY: help tag release install-local test
+.DEFAULT_GOAL := help
+
+TEST_RESULTS := test_results
+APP_NAME := actions-repository-filtering
+SYSTEM_PYTHON := python
+
+define VERSION_PYSCRIPT
+import pkg_resources
+version = pkg_resources.get_distribution('pygithubactions').version
+endef
+export VERSION_PYSCRIPT
+
+VERSION := $(SYSTEM_PYTHON) -c "$$VERSION_PYSCRIPT"
+TAG := v$(VERSION)
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+BROWSER := $(SYSTEM_PYTHON) -c "$$BROWSER_PYSCRIPT"
+
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \
+	| awk 'BEGIN {FS = ":.*?## "}; \
+	{printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+tag: ## create and push a tag for the current version
+	echo $(VERSION_PYSCRIPT)
+	# git tag $(TAG)
+	# git push origin $(TAG)
+
+release: ## package and upload a release
+	@echo "For further usage."
+
+install-local: ## install scaffold locally
+	@echo "Make sure you activated the virtual env with: 'source .venv/bin/activate'"
+	python -m pip install --upgrade pip
+	pip install -e .
+
+test: ## runs tests
+	@pytest -s -vvv
+
+coverage: ## run tests with coverage
+	@pytest --cov=pygithubactions
+
+create-results: ## create test_results directory
+	mkdir -p $(TEST_RESULTS)
+
+coverage-output: ## create outputs for coverage reports
+	@coverage html -d $(TEST_RESULTS)
+
+coverage-report: create-results coverage coverage-output ## run coverage, generate report, open in the browser
+	$(SYSTEM_PYTHON) -m webbrowser -t "file://$(PWD)/$(TEST_RESULTS)/index.html"
+
+coverage-clean: ## remove the coverage directory
+	rm -rf $(TEST_RESULTS)
+	rm .coverage
+
+isort: ## runs isort
+	@isort .
+
+format: isort ## formats python
+	@blue .
+
+lint: format ## run python flake8 linter tool
+	@flake8 --exclude .git,.venv pygithubactions
+
+static-check: ## runs static checks with mypy
+	@mypy pygithubactions
+
+precommit-install: ## install pre-commit
+	@pre-commit install
+
+precommit-run: ## run all pre-commit hooks
+	@pre-commit run -a
+
+clean: ## run clean up
+	rm -rf .pytest_cache dist build yamlvalidator.egg-info .pytest_cache .mypy_cache test_results .coverage
+	find . -type d -name '__pycache__' -exec rm -r {} +

README.md

@@ -1,2 +1,2 @@
-# py-githubaction
-Github actions core library implemented in python
+# py-githubactions
+Github actions core library implemented in python.

pygithubactions/__init__.py

@@ -0,0 +1,47 @@
+import json
+import os
+from typing import Optional
+
+
+class Context:
+    """Processes all env vars set by github in runner"""
+
+    def __init__(self) -> None:
+        self._payload: dict = {}
+        self._event_name: Optional[str] = os.getenv('GITHUB_EVENT_NAME')
+        self.sha: Optional[str] = os.getenv('GITHUB_SHA')
+        self.ref: Optional[str] = os.getenv('GITHUB_REF')
+        self.workflow: Optional[str] = os.getenv('GITHUB_WORKFLOW')
+        self.action: Optional[str] = os.getenv('GITHUB_ACTION')
+        self.actor: Optional[str] = os.getenv('GITHUB_ACTOR')
+        self.job: Optional[str] = os.getenv('GITHUB_JOB')
+        self.run_number: Optional[str] = os.getenv('GITHUB_RUN_NUMBER')
+        self.run_id: Optional[str] = os.getenv('GITHUB_RUN_ID')
+        self.api_url: str = (
+            os.getenv('GITHUB_API_URL') or 'https://api.github.com'
+        )
+        self.server_url: str = (
+            os.getenv('GITHUB_SERVER_URL') or 'https://github.com'
+        )
+        self.graphql_url: str = (
+            os.getenv('GITHUB_GRAPHQL_URL') or 'https://api.github.com/graphql'
+        )
+        self.process_payload()
+
+    def process_payload(self) -> None:
+        if 'GITHUB_EVENT_PATH' in os.environ:
+            with open(os.environ['GITHUB_EVENT_PATH'], 'r') as f:
+                content = f.read()
+                self._payload = json.loads(content)
+
+    @property
+    def payload(self) -> dict:
+        return self._payload
+
+    @property
+    def event_name(self) -> Optional[str]:
+        return self._event_name
+
+
+def get_context() -> Context:
+    return Context()