Merge "Adding pre-commit"

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+# We from the Oslo project decided to pin repos based on the
+# commit hash instead of the version tag to prevend arbitrary
+# code from running in developer's machines.  To update to a
+# newer version, run `pre-commit autoupdate` and then replace
+# the newer versions with their commit hash.
+
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: ebc15addedad713c86ef18ae9632c88e187dd0af  # v3.1.0
+    hooks:
+      - id: trailing-whitespace
+      # Replaces or checks mixed line ending
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      # Forbid files which have a UTF-8 byte-order marker
+      - id: check-byte-order-marker
+      # Checks that non-binary executables have a proper shebang
+      - id: check-executables-have-shebangs
+      # Check for files that contain merge conflict strings.
+      - id: check-merge-conflict
+      # Check for debugger imports and py37+ breakpoint()
+      # calls in python source
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 181bb46098dddf7e2d45319ea654b4b4d58c2840 # 3.8.3
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - hacking>=3.0.1,<3.1.0

doc/source/conf.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# Copyright (C) 2020 Red Hat, Inc.
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -22,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../..'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
-    #'sphinx.ext.intersphinx',
     'oslo_config.sphinxext',
     'openstackdocstheme',
     'stevedore.sphinxext',

doc/source/configuration/index.rst

@@ -3,7 +3,7 @@ Middlewares and configuration
 =============================
 
 Middlewares can be configured in multiple fashion depending of the
-application needs. Here is some use-cases: 
+application needs. Here is some use-cases:
 
 Configuration from the application
 ----------------------------------
@@ -24,8 +24,8 @@ The paste filter (in /etc/my_app/api-paste.ini) will looks like::
 
     [filter:sizelimit]
     use = egg:oslo.middleware#sizelimit
-    # In case of the application doesn't use the global oslo.config 
+    # In case of the application doesn't use the global oslo.config
-    # object. The middleware must known the app name to load 
+    # object. The middleware must known the app name to load
     # the application configuration, by setting this:
     #  oslo_config_project = my_app
 

test-requirements.txt

@@ -11,3 +11,5 @@ oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0
 # Bandit security code scanner
 bandit>=1.6.0,<1.7.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0
+
+pre-commit>=2.6.0 # MIT

tox.ini

@@ -14,7 +14,7 @@ commands = stestr run --slowest {posargs}
 
 [testenv:pep8]
 commands =
-  flake8
+  pre-commit run -a
   # Run security linter
   bandit -r oslo_middleware -x tests -n5