From fb163771bc80c278f2875e630e3b04aa2f295d07 Mon Sep 17 00:00:00 2001 From: dushu Date: Fri, 10 May 2024 18:31:21 -0400 Subject: [PATCH] chore: add pre-commit hooks --- .markdownlint.yaml | 272 ++++++++++++++++++++++++++++++++++++++++ .pre-commit-config.yaml | 35 ++++++ CONTRIBUTING.md | 49 ++++---- README.md | 76 +++++++---- renovate.json | 13 +- tox.ini | 9 ++ 6 files changed, 406 insertions(+), 48 deletions(-) create mode 100644 .markdownlint.yaml create mode 100644 .pre-commit-config.yaml diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..166bb70 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,272 @@ +# Example markdownlint configuration with all properties set to their default value + +# Default state for all rules +default: true + +# Path to configuration file to extend +extends: null + +# MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md001.md +MD001: true + +# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md003.md +MD003: + # Heading style + style: "consistent" + +# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md +MD004: + # List style + style: "consistent" + +# MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md005.md +MD005: true + +# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md +MD007: + # Spaces for indent + indent: 2 + # Whether to indent the first level of the list + start_indented: false + # Spaces for first level indent (when start_indented is set) + start_indent: 2 + +# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md +MD009: + # Spaces for line break + br_spaces: 2 + # Allow spaces for empty lines in list items + list_item_empty_lines: false + # Include unnecessary breaks + strict: false + +# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md010.md +MD010: + # Include code blocks + code_blocks: true + # Fenced code languages to ignore + ignore_code_languages: [] + # Number of spaces for each hard tab + spaces_per_tab: 1 + +# MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md011.md +MD011: true + +# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md +MD012: + # Consecutive blank lines + maximum: 1 + +# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md +MD013: + # Number of characters + line_length: 80 + # Number of characters for headings + heading_line_length: 80 + # Number of characters for code blocks + code_block_line_length: 80 + # Include code blocks + code_blocks: false + # Include tables + tables: false + # Include headings + headings: false + # Strict length checking + strict: false + # Stern length checking + stern: false + +# MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md014.md +MD014: true + +# MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md018.md +MD018: true + +# MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md019.md +MD019: true + +# MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md020.md +MD020: true + +# MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md021.md +MD021: true + +# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md +MD022: + # Blank lines above heading + lines_above: 1 + # Blank lines below heading + lines_below: 1 + +# MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md023.md +MD023: true + +# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md +MD024: + # Only check sibling headings + siblings_only: false + +# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md +MD025: + # Heading level + level: 1 + # RegExp for matching title in front matter + front_matter_title: "^\\s*title\\s*[:=]" + +# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md026.md +MD026: + # Punctuation characters + punctuation: ".,;:!。，；：！" + +# MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md027.md +MD027: true + +# MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md028.md +MD028: true + +# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md029.md +MD029: + # List style + style: "one_or_ordered" + +# MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md030.md +MD030: + # Spaces for single-line unordered list items + ul_single: 1 + # Spaces for single-line ordered list items + ol_single: 1 + # Spaces for multi-line unordered list items + ul_multi: 1 + # Spaces for multi-line ordered list items + ol_multi: 1 + +# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md +MD031: + # Include list items + list_items: true + +# MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md032.md +MD032: true + +# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md +MD033: + # Allowed elements + allowed_elements: [] + +# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md034.md +MD034: true + +# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md035.md +MD035: + # Horizontal rule style + style: "consistent" + +# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md036.md +MD036: + # Punctuation characters + punctuation: ".,;:!?。，；：！？" + +# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md037.md +MD037: true + +# MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md038.md +MD038: true + +# MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md039.md +MD039: true + +# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md040.md +MD040: + # List of languages + allowed_languages: [] + # Require language only + language_only: false + +# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md041.md +MD041: + # Heading level + level: 1 + # RegExp for matching title in front matter + front_matter_title: "^\\s*title\\s*[:=]" + +# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md042.md +MD042: true + +# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md043.md +# MD043: + # List of headings + # headings: [] + # Match case of headings + # match_case: false + +# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md044.md +MD044: + # List of proper names + names: [] + # Include code blocks + code_blocks: true + # Include HTML elements + html_elements: true + +# MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md045.md +MD045: true + +# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md046.md +MD046: + # Block style + style: "consistent" + +# MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md +MD047: true + +# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md048.md +MD048: + # Code fence style + style: "consistent" + +# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md049.md +MD049: + # Emphasis style + style: "consistent" + +# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md050.md +MD050: + # Strong style + style: "consistent" + +# MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md051.md +MD051: true + +# MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md052.md +MD052: + # Include shortcut syntax + shortcut_syntax: false + +# MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md053.md +MD053: + # Ignored definitions + ignored_definitions: + - "//" + +# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md054.md +MD054: + # Allow autolinks + autolink: true + # Allow inline links and images + inline: true + # Allow full reference links and images + full: true + # Allow collapsed reference links and images + collapsed: true + # Allow shortcut reference links and images + shortcut: true + # Allow URLs as inline links + url_inline: true + +# MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md055.md +MD055: + # Table pipe style + style: "consistent" + +# MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md +MD056: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..51035f2 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,35 @@ +exclude: ^(img/) +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-added-large-files + - id: debug-statements + - id: detect-private-key + - id: end-of-file-fixer + - id: requirements-txt-fixer + - id: trailing-whitespace +- repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.7 + hooks: + - id: ruff + args: [--fix, --exit-non-zero-on-fix] +- repo: https://github.com/psf/black + rev: 24.4.0 + hooks: + - id: black +- repo: https://github.com/pre-commit/mirrors-mypy + rev: v1.9.0 + hooks: + - id: mypy + args: ["--config-file", "pyproject.toml"] + additional_dependencies: + - types-PyYAML +- repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.39.0 + hooks: + - id: markdownlint +- repo: https://github.com/renovatebot/pre-commit-hooks + rev: 37.353.0 + hooks: + - id: renovate-config-validator diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54ac7e8..4c8eea5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,56 +2,63 @@ ## Overview -This documents explains the processes and practices recommended for contributing enhancements to +This documents explains the processes and practices recommended for contributing +enhancements to this operator. -- Generally, before developing enhancements to this charm, you should consider [opening an issue - ](https://github.com/canonical/openfga-operator/issues) explaining your use case. -- If you would like to chat with us about your use-cases or proposed implementation, you can reach - us at [Discourse](https://discourse.charmhub.io/). -- Familiarising yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) library +- Generally, before developing enhancements to this charm, you should + consider [opening an issue](https://github.com/canonical/openfga-operator/issues) + explaining your use case. +- If you would like to chat with us about your use-cases or proposed + implementation, you can reach us + at [Discourse](https://discourse.charmhub.io/). +- Familiarising yourself with + the [Charmed Operator Framework](https://juju.is/docs/sdk) library will help you a lot when working on new features or bug fixes. -- All enhancements require review before being merged. Code review typically examines +- All enhancements require review before being merged. Code review typically + examines - code quality - test coverage - user experience for Juju administrators this charm. -- Please help us out in ensuring easy to review branches by rebasing your pull request branch onto - the `main` branch. This also avoids merge commits and creates a linear Git commit history. +- Please help us out in ensuring easy to review branches by rebasing your pull + request branch onto the `main` branch. This also avoids merge commits and + creates a linear Git commit history. ## Developing -You can create an environment for development with `tox`: +You can use the environments created by `tox` for development. It helps +install `pre-commit` and `mypy` type checker. ```shell -tox -e integration -source venv/bin/activate +tox -e dev +source .tox/dev/bin/activate ``` -### Testing +## Testing ```shell -tox -e fmt # update your code according to linting rules +tox -e fmt # update your code according to linting rules tox -e lint # code style tox -e unit # unit tests tox -e integration # integration tests -tox # runs 'lint' and 'unit' environments +tox #runs 'fmt', 'lint', and 'unit' environments ``` +## Building -## Build charm - -Build the charm in this git repository using: +Build the charm using: ```shell charmcraft pack ``` -### Deploy +## Deploying -```bash +```shell # Create a model juju add-model dev # Enable DEBUG logging juju model-config logging-config="=INFO;unit=DEBUG" # Deploy the charm -juju deploy ./openfga-k8s_ubuntu-22.04-amd64.charm \ No newline at end of file +juju deploy ./openfga-k8s_ubuntu-22.04-amd64.charm +``` diff --git a/README.md b/README.md index cf43f6c..0ef2fb1 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,20 @@ ## Description -This repository contains a [Juju Charm](https://charmhub.io/openfga-k8s) for deploying [OpenFGA](https://openfga.dev/) on Kubernetes. +This repository contains a [Juju Charm](https://charmhub.io/openfga-k8s) for +deploying [OpenFGA](https://openfga.dev/) on Kubernetes. ## Usage -Bootstrap a [microk8s controller](https://juju.is/docs/olm/microk8s) using juju `3.2` and create a new Juju model: +Bootstrap a [microk8s controller](https://juju.is/docs/olm/microk8s) using +juju `3.2` and create a new Juju model: ```shell juju add-model openfga ``` ### Basic Usage + To deploy a single unit of OpenFGA using its default configuration. ```shell @@ -23,9 +26,9 @@ juju deploy postgresql-k8s --channel edge juju integrate postgresql-k8s:database openfga-k8s ``` -#### New `openfga` interface: +#### `openfga` interface -Current charm provides a library for the `openfga` relation interface. Your +Current charm provides a library for the `openfga` integration interface. Your application should define an interface in `metadata.yaml`: ```yaml @@ -35,58 +38,83 @@ requires: ``` Then run + ```shell charmcraft fetch-lib charms.openfga_k8s.v1.openfga ``` -Please read usage documentation about -[openfga](https://charmhub.io/openfga-k8s/libraries/openfga) library for +Please read usage documentation +about [openfga](https://charmhub.io/openfga-k8s/libraries/openfga) library for more information about how to enable PostgreSQL interface in your application. -Relations to new applications are supported via the `openfga` interface. To create a -relation: +Integrations to new applications are supported via the `openfga` interface. To +create an integration: ```shell -juju integrate openfga-k8s application +juju integrate openfga-k8s ``` -To remove a relation: +To remove an integration: + ```shell -juju remove-relation openfga-k8s application +juju remove-relation openfga-k8s ``` -#### `tls-certificates` interface: +#### `tls-certificates` interface -The Charmed PostgreSQL Operator also supports TLS encryption on internal and external connections. To enable TLS: +The Charmed PostgreSQL Operator also supports TLS encryption on internal and +external connections. To enable TLS: ```shell # Deploy the TLS Certificates Operator. juju deploy tls-certificates-operator --channel=edge # Add the necessary configurations for TLS. juju config tls-certificates-operator generate-self-signed-certificates="true" ca-common-name="Test CA" -# Enable TLS via relation. -juju relate openfga-k8s tls-certificates-operator -# Disable TLS by removing relation. +# Enable TLS via integration. +juju integrate openfga-k8s tls-certificates-operator +# Disable TLS by removing integration. juju remove-relation openfga-k8s tls-certificates-operator ``` -Note: The TLS settings shown here are for self-signed-certificates, which are not recommended for production clusters. The TLS Certificates Operator offers a variety of configurations. Read more on the TLS Certificates Operator [here](https://charmhub.io/tls-certificates-operator). +Note: The TLS settings shown here are for self-signed-certificates, which are +not recommended for production clusters. The TLS Certificates Operator offers a +variety of configurations. Read more on the TLS Certificates +Operator [here](https://charmhub.io/tls-certificates-operator). ## Observability -This OpenFGA operator integrates with [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack) (COS) bundle. -It comes with a Grafana dashboard and Loki and Prometheus alert rules for basic common scenarios. -To integrate with the COS bundle, after you [deploy it](https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s#heading--deploy-the-cos-lite-bundle), you can run: -```bash + +This OpenFGA operator integrates +with [Canonical Observability Stack (COS)](https://charmhub.io/topics/canonical-observability-stack) +bundle. +It comes with a Grafana dashboard and Loki and Prometheus alert rules for basic +common scenarios. To integrate with the COS bundle, after +you [deploy it](https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s#heading--deploy-the-cos-lite-bundle), +you can run: + +```shell juju integrate openfga:grafana-dashboard grafana:grafana-dashboard juju integrate openfga:metrics-endpoint prometheus:metrics-endpoint juju integrate loki:logging openfga:log-proxy ``` ## Security -Security issues in the Charmed OpenFGA k8s Operator can be reported through [LaunchPad](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File). Please do not file GitHub issues about security issues. + +Security issues in the Charmed OpenFGA k8s Operator can be reported +through [LaunchPad](https://wiki.ubuntu.com/DebuggingSecurity#How%20to%20File). +Please do not file GitHub issues about security issues. ## Contributing -Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines on enhancements to this charm following best practice guidelines, and [CONTRIBUTING.md](https://github.com/canonical/openfga-operator/blob/main/CONTRIBUTING.md) for developer guidance. + +Please see the [Juju SDK docs](https://juju.is/docs/sdk) for guidelines on +enhancements to this charm following best practice guidelines, +and [CONTRIBUTING.md](https://github.com/canonical/openfga-operator/blob/main/CONTRIBUTING.md) +for developer guidance. ## License -The OpenFGA k8s charm [is distributed](https://github.com/canonical/openfga-operator/blob/main/LICENSE) under the Apache Software License, version 2.0. It installs/operates/depends on [OpenFGA](https://github.com/openfga/openfga), which [is licensed](https://github.com/openfga/openfga/blob/main/LICENSE) under the Apache Software License, version 2.0. + +The OpenFGA k8s +charm [is distributed](https://github.com/canonical/openfga-operator/blob/main/LICENSE) +under the Apache Software License, version 2.0. It installs/operates/depends +on [OpenFGA](https://github.com/openfga/openfga), +which [is licensed](https://github.com/openfga/openfga/blob/main/LICENSE) under +the Apache Software License, version 2.0. diff --git a/renovate.json b/renovate.json index 7d13705..3b36b6b 100644 --- a/renovate.json +++ b/renovate.json @@ -9,7 +9,8 @@ ":rebaseStalePrs", ":semanticCommits", ":semanticCommitScope(deps)", - "helpers:pinGitHubActionDigests" + "helpers:pinGitHubActionDigests", + ":enablePreCommit" ], "automergeType": "pr", "rebaseWhen": "behind-base-branch", @@ -25,7 +26,6 @@ { "groupName": "operator pip deps", "matchManagers": ["pip_requirements"], - "fileMatch": ["requirements\\.txt$"], "matchUpdateTypes": ["minor", "patch", "pin", "digest"], "schedule": ["at any time"], "prPriority": 5, @@ -34,7 +34,6 @@ { "groupName": "operator pip deps", "matchManagers": ["pip_requirements"], - "fileMatch": ["requirements\\.txt$"], "matchUpdateTypes": ["major"], "schedule": ["at any time"], "prPriority": 5 @@ -63,6 +62,14 @@ "automerge": true, "schedule": ["at any time"], "additionalBranchPrefix": "auto-" + }, + { + "groupName": "pre-commit hooks", + "matchManagers": ["pre-commit"], + "matchUpdateTypes": ["major", "minor", "patch", "pin", "digest"], + "automerge": true, + "schedule": ["at any time"], + "additionalBranchPrefix": "auto-" } ] } diff --git a/tox.ini b/tox.ini index eaec40d..799931b 100644 --- a/tox.ini +++ b/tox.ini @@ -22,6 +22,15 @@ passenv = CHARM_BUILD_DIR MODEL_SETTINGS +[testenv:dev] +description = Prepare local development tools +deps = + pre-commit + mypy + types-PyYAML +commands = + pre-commit install + [testenv:fmt] description = Apply coding style standards to code deps =