adopt pre-commit hooks
Change-Id: I98bc0b5717c3921b35e74f53c55f896427880a84 Signed-off-by: Sorin Sbarnea <ssbarnea@redhat.com>
This commit is contained in:
Sorin Sbarnea
parent
f9b5016ab7
commit
4953756c27
11
.pre-commit-config.yaml
Normal file
11
.pre-commit-config.yaml
Normal file
@ -0,0 +1,11 @@
|
||||
# See https://pre-commit.com for more information
|
||||
# See https://pre-commit.com/hooks.html for more hooks
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v1.2.1-1
|
||||
hooks:
|
||||
- id: check-added-large-files
|
||||
- id: end-of-file-fixer
|
||||
- id: flake8
|
||||
args: ['--config=setup.cfg']
|
||||
- id: trailing-whitespace
|
||||
@ -29,6 +29,9 @@ Cloning::
|
||||
|
||||
git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
|
||||
|
||||
Install pre-commit from https://pre-commit.com/#intro in order to run some
|
||||
minimal testing on your commits.
|
||||
|
||||
A virtual environment is recommended for development. For example, Jenkins
|
||||
Job Builder may be installed from the top level directory::
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
# Jenkins Job Builder documentation build configuration file, created by
|
||||
# sphinx-quickstart on Mon Sep 10 19:36:21 2012.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
# This file is execfile()d with the current directory set to its containing dir
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
@ -11,7 +11,9 @@
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys, os
|
||||
import os
|
||||
import sys
|
||||
from jenkins_jobs.version import version_info as jenkins_jobs_version
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
@ -19,13 +21,13 @@ import sys, os
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
sys.path.insert(0, os.path.abspath('../../jenkins_jobs/modules'))
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
# -- General configuration ----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage',
|
||||
'jenkins_jobs.sphinx.yaml', 'sphinxcontrib.programoutput',
|
||||
'sphinx.ext.extlinks']
|
||||
@ -51,7 +53,6 @@ copyright = u'2012, Jenkins Job Builder Maintainers'
|
||||
# built documents.
|
||||
#
|
||||
# Version info
|
||||
from jenkins_jobs.version import version_info as jenkins_jobs_version
|
||||
release = jenkins_jobs_version.version_string_with_vcs()
|
||||
# The short X.Y version.
|
||||
version = jenkins_jobs_version.canonical_version_string()
|
||||
@ -70,7 +71,7 @@ version = jenkins_jobs_version.canonical_version_string()
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
# The reST default role (used for this markup: `text`) to use for all documents
|
||||
# default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
@ -91,7 +92,7 @@ pygments_style = 'sphinx'
|
||||
# modindex_common_prefix = []
|
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
# -- Options for HTML output --------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
@ -171,7 +172,7 @@ html_theme = 'default'
|
||||
htmlhelp_basename = 'JenkinsJobBuilderdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
# -- Options for LaTeX output -------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
@ -185,7 +186,8 @@ latex_elements = {
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
# (source start file, target name, title, author, documentclass
|
||||
# [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'JenkinsJobBuilder.tex', u'Jenkins Job Builder Documentation',
|
||||
u'Jenkins Job Builder Maintainers', 'manual'),
|
||||
@ -218,7 +220,7 @@ latex_documents = [
|
||||
linkcheck_timeout = 15
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
# -- Options for manual page output ------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
@ -231,14 +233,15 @@ man_pages = [
|
||||
# man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------------
|
||||
# -- Options for Texinfo output -----------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'JenkinsJobBuilder', u'Jenkins Job Builder Documentation',
|
||||
u'Jenkins Job Builder Maintainers', 'JenkinsJobBuilder', 'One line description of project.',
|
||||
u'Jenkins Job Builder Maintainers',
|
||||
'JenkinsJobBuilder', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
@ -97,3 +97,10 @@ jenkins_jobs.modules =
|
||||
triggers=jenkins_jobs.modules.triggers:Triggers
|
||||
wrappers=jenkins_jobs.modules.wrappers:Wrappers
|
||||
zuul=jenkins_jobs.modules.zuul:Zuul
|
||||
|
||||
[flake8]
|
||||
# These are ignored intentionally in openstack-infra projects; please
|
||||
# don't submit patches that solely correct them or enable them.
|
||||
ignore = E125,E128,H
|
||||
show-source = True
|
||||
exclude = .virtualenv,.venv,.tox,dist,build,*.egg,.test
|
||||
|
||||
@ -13,3 +13,4 @@ stestr>=2.0.0 # Apache-2.0/BSD
|
||||
tox>=2.9.1 # MIT
|
||||
mock>=2.0 # BSD
|
||||
sphinxcontrib-programoutput
|
||||
pre-commit
|
||||
|
||||
@ -246,7 +246,8 @@ class SingleJobTestCase(BaseScenariosTestCase):
|
||||
def test_yaml_snippet(self):
|
||||
config = self._get_config()
|
||||
|
||||
expected_xml = self._read_utf8_content().strip()
|
||||
expected_xml = self._read_utf8_content().strip() \
|
||||
.replace('<BLANKLINE>', '').replace('\n\n', '\n')
|
||||
|
||||
parser = YamlParser(config)
|
||||
parser.parse(self.in_filename)
|
||||
@ -290,14 +291,14 @@ class SingleJobTestCase(BaseScenariosTestCase):
|
||||
|
||||
# Prettify generated XML
|
||||
pretty_xml = u"\n".join(job.output().decode('utf-8')
|
||||
for job in xml_jobs).strip()
|
||||
for job in xml_jobs) \
|
||||
.strip().replace('\n\n', '\n')
|
||||
|
||||
self.assertThat(
|
||||
pretty_xml,
|
||||
testtools.matchers.DocTestMatches(expected_xml,
|
||||
doctest.ELLIPSIS |
|
||||
doctest.REPORT_NDIFF)
|
||||
)
|
||||
doctest.REPORT_NDIFF))
|
||||
|
||||
|
||||
class JsonTestCase(BaseScenariosTestCase):
|
||||
|
||||
@ -11,4 +11,3 @@ scm:
|
||||
head-filter-regex: 'master|\d+\.\d+'
|
||||
discover-pr-origin: headOnly
|
||||
discover-branch: all
|
||||
|
||||
|
||||
@ -13,4 +13,3 @@
|
||||
<publishers/>
|
||||
<buildWrappers/>
|
||||
</project>
|
||||
|
||||
|
||||
10
tox.ini
10
tox.ini
@ -46,7 +46,8 @@ commands =
|
||||
|
||||
[testenv:pep8]
|
||||
basepython = python3
|
||||
commands = flake8
|
||||
commands =
|
||||
python -m pre_commit run --all
|
||||
|
||||
[testenv:pyflakes]
|
||||
deps = pyflakes
|
||||
@ -72,10 +73,3 @@ commands = python setup.py build_sphinx -b linkcheck
|
||||
|
||||
[testenv:venv]
|
||||
commands = {posargs}
|
||||
|
||||
[flake8]
|
||||
# These are ignored intentionally in openstack-infra projects; please
|
||||
# don't submit patches that solely correct them or enable them.
|
||||
ignore = E125,E128,H
|
||||
show-source = True
|
||||
exclude = .virtualenv,.venv,.tox,dist,doc,build,*.egg,.test
|
||||
|
||||
Loading…
Reference in New Issue
Block a user