Adopt black as code formatter (#148)

* Replace yapf with black on pre-commit

* Making pre-commit happy

Author: cletomartin

.flake8

@@ -2,6 +2,9 @@
 
 # Sphinx documentation
 doc
+doc-source/compliance.rst
+doc-source/compliance.*.rst
+doc-source/modules.rst
 
 ### Emacs
 

.gitignore

@@ -6,41 +6,18 @@ repos:
       -   id: check-yaml
       -   id: fix-encoding-pragma
           args: ["--remove"]  # Not needed on python3
--   repo: https://github.com/google/yapf
-    rev: v0.32.0
+-   repo: https://github.com/ambv/black
+    rev: 22.12.0
     hooks:
-    -   id: yapf
-        args: [--in-place, --parallel, --recursive, --style, .yapf-config]
-        files: "^(compliance|test)"
-        stages: [commit]
+      - id: black
 -   repo: https://github.com/PyCQA/flake8
-    rev: 5.0.4
+    rev: 6.0.0
     hooks:
     -   id: flake8
-        additional_dependencies: [
-          flake8-2020,
-          flake8-broken-line,
-          flake8-bugbear,
-          flake8-builtins,
-          flake8-commas,
-          flake8-comprehensions,
-          flake8-docstrings,
-          flake8-eradicate,
-          flake8-import-order,
-          flake8-mutable,
-          flake8-pep3101,
-          flake8-print,
-          flake8-quotes,
-          flake8-string-format,
-          flake8-use-fstring,
-          pep8-naming
-        ]
         files: "^(compliance|test|demo)"
-        stages: [commit]
 -   repo: https://github.com/PyCQA/bandit
     rev: 1.7.4
     hooks:
     -   id: bandit
         args: [--recursive]
         files: "^(compliance|test)"
-        stages: [commit]

.pre-commit-config.yaml

@@ -9,6 +9,7 @@
 - [ADDED] Documentation about using @parameterized.
 - [CHANGED] Unify github demo code in one single place.
 - [FIXED] flake8 now scans demo code too.
+- [CHANGED] Removed yapf in favour of black as code formatter.
 
 # [1.23.0](https://github.com/ComplianceAsCode/auditree-framework/releases/tag/v1.23.0)
 

.yapf-config

@@ -41,9 +41,9 @@ There are some guidelines to follow when making a common fetcher or check:
 
 ## Code formatting and style
 
-Please ensure all code contributions are formatted by `yapf` and pass all `flake8` linter requirements.
-CI/CD will run `yapf` and `flake8` on all new commits and reject changes if there are failures.  If you
-run `make develop` to setup and maintain your virtual environment then `yapf` and `flake8` will be executed
+Please ensure all code contributions are formatted by `black` and pass all `flake8` linter requirements.
+CI/CD will run `black` and `flake8` on all new commits and reject changes if there are failures.  If you
+run `make develop` to setup and maintain your virtual environment then `black` and `flake8` will be executed
 automatically as part of all git commits.  If you'd like to run things manually you can do so locally by using:
 
 ```shell
@@ -81,4 +81,4 @@ example `[ADDED]`, `[CHANGED]`, etc.
 [Coding Standards]: https://complianceascode.github.io/auditree-framework/coding-standards.html
 [flake8]: https://gitlab.com/pycqa/flake8
 [new collab]: https://github.com/ComplianceAsCode/auditree-framework/issues/new?template=new-collaborator.md
-[yapf]: https://github.com/google/yapf
+[black]: https://github.com/psf/black

CHANGES.md

@@ -31,7 +31,7 @@ uninstall:
 	pip uninstall auditree-framework
 
 code-format:
-	pre-commit run yapf --all-files
+	pre-commit run black --all-files
 
 code-lint:
 	pre-commit run flake8 --all-files

CONTRIBUTING.md

@@ -44,32 +44,32 @@ make develop
 
 #### Code style and formatting
 
-This repository uses [yapf][yapf] for code formatting and [flake8][flake8] for code styling.  It also
+This repository uses [black][black] for code formatting and [flake8][flake8] for code styling.  It also
 uses [pre-commit][pre-commit] hooks that are integrated into the development process and the CI.  When
 you run `make develop` you are ensuring that the pre-commit hooks are installed and updated to their
 latest versions for this repository.  This ensures that all delivered code has been properly formatted
 and passes the linter rules.  See the [pre-commit configuration file][pre-commit-config] for details on
-`yapf` and `flake8` configurations.
+`black` and `flake8` configurations.
 
-Since `yapf` and `flake8` are installed as part of the `pre-commit` hooks, running `yapf` and `flake8`
+Since `black` and `flake8` are installed as part of the `pre-commit` hooks, running `black` and `flake8`
 manually must be done through `pre-commit`.  See examples below:
 
 ```shell
 make code-format
 make code-lint
 ```
 
-...will run `yapf` and `flake8` on the entire repo and is equivalent to:
+...will run `black` and `flake8` on the entire repo and is equivalent to:
 
 ```shell
-pre-commit run yapf --all-files
+pre-commit run black --all-files
 pre-commit run flake8 --all-files
 ```
 
 ...and when looking to limit execution to a subset of files do similar to:
 
 ```shell
-pre-commit run yapf --files compliance/*
+pre-commit run black --files compliance/*
 pre-commit run flake8 --files compliance/*
 ```
 
@@ -152,7 +152,7 @@ We have a tool called [Plant](https://github.com/ComplianceAsCode/auditree-plant
 [python-badge]: https://img.shields.io/badge/python-v3.6+-blue.svg
 [python]: https://www.python.org/downloads/
 [quick start guide]: https://github.com/ComplianceAsCode/auditree-framework/blob/master/doc-source/quick-start.rst
-[yapf]: https://github.com/google/yapf
+[black]: https://github.com/psf/black
 [lint-test]: https://github.com/ComplianceAsCode/auditree-framework/actions?query=workflow%3A%22format+%7C+lint+%7C+test%22
 [pypi-upload]: https://github.com/ComplianceAsCode/auditree-framework/actions?query=workflow%3A%22PyPI+upload%22
 [credentials]: https://complianceascode.github.io/auditree-framework/design-principles.html#credentials

Makefile

@@ -13,4 +13,4 @@
 # limitations under the License.
 """Compliance automation package."""
 
-__version__ = '1.24.0'
+__version__ = "1.24.0"

README.md

@@ -29,8 +29,8 @@
 class ComplianceAgent:
     """Compliance agent class."""
 
-    AGENTS_DIR = 'agents'
-    PUBLIC_KEYS_EVIDENCE_PATH = 'raw/auditree/agent_public_keys.json'
+    AGENTS_DIR = "agents"
+    PUBLIC_KEYS_EVIDENCE_PATH = "raw/auditree/agent_public_keys.json"
 
     def __init__(self, name=None, use_agent_dir=True):
         """Construct and initialize the agent object."""
@@ -126,10 +126,9 @@ def hash_and_sign(self, data_bytes):
         signature = self.private_key.sign(
             hashed.digest(),
             padding.PSS(
-                mgf=padding.MGF1(hashes.SHA256()),
-                salt_length=padding.PSS.MAX_LENGTH
+                mgf=padding.MGF1(hashes.SHA256()), salt_length=padding.PSS.MAX_LENGTH
             ),
-            Prehashed(hashes.SHA256())
+            Prehashed(hashes.SHA256()),
         )
         return hashed.hexdigest(), base64.b64encode(signature).decode()
 
@@ -150,9 +149,9 @@ def verify(self, data_bytes, signature_b64):
                 data_bytes,
                 padding.PSS(
                     mgf=padding.MGF1(hashes.SHA256()),
-                    salt_length=padding.PSS.MAX_LENGTH
+                    salt_length=padding.PSS.MAX_LENGTH,
                 ),
-                hashes.SHA256()
+                hashes.SHA256(),
             )
             return True
         except InvalidSignature:
@@ -163,19 +162,19 @@ def from_config(cls):
         """Load agent from configuration."""
         config = get_config()
         agent = cls(
-            name=config.get('agent_name'),
-            use_agent_dir=config.get('use_agent_dir', True)
+            name=config.get("agent_name"),
+            use_agent_dir=config.get("use_agent_dir", True),
         )
-        private_key_path = config.get('agent_private_key')
-        public_key_path = config.get('agent_public_key')
+        private_key_path = config.get("agent_private_key")
+        public_key_path = config.get("agent_public_key")
         if private_key_path:
-            with open(private_key_path, 'rb') as key_file:
+            with open(private_key_path, "rb") as key_file:
                 agent.private_key = key_file.read()
             agent.public_key = agent.private_key.public_key().public_bytes(
                 encoding=serialization.Encoding.PEM,
-                format=serialization.PublicFormat.SubjectPublicKeyInfo
+                format=serialization.PublicFormat.SubjectPublicKeyInfo,
             )
         elif public_key_path:
-            with open(public_key_path, 'rb') as key_file:
+            with open(public_key_path, "rb") as key_file:
                 agent.public_key = key_file.read()
         return agent