Browse Source

Initial boilerplate, packaging and testing

This copies the documentation scaffold, packaging setup, testing
framework and development environment files from the zuul-jobs repo
for consistency.

Change-Id: I64046054a65c3e01b0b81c01813482b67535d51b
Depends-On: Ib43621d29c4082c3a34a221a6462910364c19319
master
Jeremy Stanley 1 year ago
parent
commit
5d5813a7f6
10 changed files with 414 additions and 0 deletions
  1. 13
    0
      .gitignore
  2. 202
    0
      LICENSE
  3. 6
    0
      README.rst
  4. 12
    0
      bindep.txt
  5. 73
    0
      doc/source/conf.py
  6. 11
    0
      doc/source/index.rst
  7. 21
    0
      setup.cfg
  8. 28
    0
      setup.py
  9. 11
    0
      test-requirements.txt
  10. 37
    0
      tox.ini

+ 13
- 0
.gitignore View File

@@ -0,0 +1,13 @@
1
+*.pyc
2
+*~
3
+
4
+# Unit test / coverage reports
5
+.coverage
6
+.tox
7
+
8
+# Sphinx
9
+doc/build
10
+
11
+# pbr generates these
12
+AUTHORS
13
+ChangeLog

+ 202
- 0
LICENSE View File

@@ -0,0 +1,202 @@
1
+
2
+                                 Apache License
3
+                           Version 2.0, January 2004
4
+                        http://www.apache.org/licenses/
5
+
6
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+   1. Definitions.
9
+
10
+      "License" shall mean the terms and conditions for use, reproduction,
11
+      and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+      "Licensor" shall mean the copyright owner or entity authorized by
14
+      the copyright owner that is granting the License.
15
+
16
+      "Legal Entity" shall mean the union of the acting entity and all
17
+      other entities that control, are controlled by, or are under common
18
+      control with that entity. For the purposes of this definition,
19
+      "control" means (i) the power, direct or indirect, to cause the
20
+      direction or management of such entity, whether by contract or
21
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+      outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+      "You" (or "Your") shall mean an individual or Legal Entity
25
+      exercising permissions granted by this License.
26
+
27
+      "Source" form shall mean the preferred form for making modifications,
28
+      including but not limited to software source code, documentation
29
+      source, and configuration files.
30
+
31
+      "Object" form shall mean any form resulting from mechanical
32
+      transformation or translation of a Source form, including but
33
+      not limited to compiled object code, generated documentation,
34
+      and conversions to other media types.
35
+
36
+      "Work" shall mean the work of authorship, whether in Source or
37
+      Object form, made available under the License, as indicated by a
38
+      copyright notice that is included in or attached to the work
39
+      (an example is provided in the Appendix below).
40
+
41
+      "Derivative Works" shall mean any work, whether in Source or Object
42
+      form, that is based on (or derived from) the Work and for which the
43
+      editorial revisions, annotations, elaborations, or other modifications
44
+      represent, as a whole, an original work of authorship. For the purposes
45
+      of this License, Derivative Works shall not include works that remain
46
+      separable from, or merely link (or bind by name) to the interfaces of,
47
+      the Work and Derivative Works thereof.
48
+
49
+      "Contribution" shall mean any work of authorship, including
50
+      the original version of the Work and any modifications or additions
51
+      to that Work or Derivative Works thereof, that is intentionally
52
+      submitted to Licensor for inclusion in the Work by the copyright owner
53
+      or by an individual or Legal Entity authorized to submit on behalf of
54
+      the copyright owner. For the purposes of this definition, "submitted"
55
+      means any form of electronic, verbal, or written communication sent
56
+      to the Licensor or its representatives, including but not limited to
57
+      communication on electronic mailing lists, source code control systems,
58
+      and issue tracking systems that are managed by, or on behalf of, the
59
+      Licensor for the purpose of discussing and improving the Work, but
60
+      excluding communication that is conspicuously marked or otherwise
61
+      designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+      "Contributor" shall mean Licensor and any individual or Legal Entity
64
+      on behalf of whom a Contribution has been received by Licensor and
65
+      subsequently incorporated within the Work.
66
+
67
+   2. Grant of Copyright License. Subject to the terms and conditions of
68
+      this License, each Contributor hereby grants to You a perpetual,
69
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+      copyright license to reproduce, prepare Derivative Works of,
71
+      publicly display, publicly perform, sublicense, and distribute the
72
+      Work and such Derivative Works in Source or Object form.
73
+
74
+   3. Grant of Patent License. Subject to the terms and conditions of
75
+      this License, each Contributor hereby grants to You a perpetual,
76
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+      (except as stated in this section) patent license to make, have made,
78
+      use, offer to sell, sell, import, and otherwise transfer the Work,
79
+      where such license applies only to those patent claims licensable
80
+      by such Contributor that are necessarily infringed by their
81
+      Contribution(s) alone or by combination of their Contribution(s)
82
+      with the Work to which such Contribution(s) was submitted. If You
83
+      institute patent litigation against any entity (including a
84
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+      or a Contribution incorporated within the Work constitutes direct
86
+      or contributory patent infringement, then any patent licenses
87
+      granted to You under this License for that Work shall terminate
88
+      as of the date such litigation is filed.
89
+
90
+   4. Redistribution. You may reproduce and distribute copies of the
91
+      Work or Derivative Works thereof in any medium, with or without
92
+      modifications, and in Source or Object form, provided that You
93
+      meet the following conditions:
94
+
95
+      (a) You must give any other recipients of the Work or
96
+          Derivative Works a copy of this License; and
97
+
98
+      (b) You must cause any modified files to carry prominent notices
99
+          stating that You changed the files; and
100
+
101
+      (c) You must retain, in the Source form of any Derivative Works
102
+          that You distribute, all copyright, patent, trademark, and
103
+          attribution notices from the Source form of the Work,
104
+          excluding those notices that do not pertain to any part of
105
+          the Derivative Works; and
106
+
107
+      (d) If the Work includes a "NOTICE" text file as part of its
108
+          distribution, then any Derivative Works that You distribute must
109
+          include a readable copy of the attribution notices contained
110
+          within such NOTICE file, excluding those notices that do not
111
+          pertain to any part of the Derivative Works, in at least one
112
+          of the following places: within a NOTICE text file distributed
113
+          as part of the Derivative Works; within the Source form or
114
+          documentation, if provided along with the Derivative Works; or,
115
+          within a display generated by the Derivative Works, if and
116
+          wherever such third-party notices normally appear. The contents
117
+          of the NOTICE file are for informational purposes only and
118
+          do not modify the License. You may add Your own attribution
119
+          notices within Derivative Works that You distribute, alongside
120
+          or as an addendum to the NOTICE text from the Work, provided
121
+          that such additional attribution notices cannot be construed
122
+          as modifying the License.
123
+
124
+      You may add Your own copyright statement to Your modifications and
125
+      may provide additional or different license terms and conditions
126
+      for use, reproduction, or distribution of Your modifications, or
127
+      for any such Derivative Works as a whole, provided Your use,
128
+      reproduction, and distribution of the Work otherwise complies with
129
+      the conditions stated in this License.
130
+
131
+   5. Submission of Contributions. Unless You explicitly state otherwise,
132
+      any Contribution intentionally submitted for inclusion in the Work
133
+      by You to the Licensor shall be under the terms and conditions of
134
+      this License, without any additional terms or conditions.
135
+      Notwithstanding the above, nothing herein shall supersede or modify
136
+      the terms of any separate license agreement you may have executed
137
+      with Licensor regarding such Contributions.
138
+
139
+   6. Trademarks. This License does not grant permission to use the trade
140
+      names, trademarks, service marks, or product names of the Licensor,
141
+      except as required for reasonable and customary use in describing the
142
+      origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+   7. Disclaimer of Warranty. Unless required by applicable law or
145
+      agreed to in writing, Licensor provides the Work (and each
146
+      Contributor provides its Contributions) on an "AS IS" BASIS,
147
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+      implied, including, without limitation, any warranties or conditions
149
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+      PARTICULAR PURPOSE. You are solely responsible for determining the
151
+      appropriateness of using or redistributing the Work and assume any
152
+      risks associated with Your exercise of permissions under this License.
153
+
154
+   8. Limitation of Liability. In no event and under no legal theory,
155
+      whether in tort (including negligence), contract, or otherwise,
156
+      unless required by applicable law (such as deliberate and grossly
157
+      negligent acts) or agreed to in writing, shall any Contributor be
158
+      liable to You for damages, including any direct, indirect, special,
159
+      incidental, or consequential damages of any character arising as a
160
+      result of this License or out of the use or inability to use the
161
+      Work (including but not limited to damages for loss of goodwill,
162
+      work stoppage, computer failure or malfunction, or any and all
163
+      other commercial damages or losses), even if such Contributor
164
+      has been advised of the possibility of such damages.
165
+
166
+   9. Accepting Warranty or Additional Liability. While redistributing
167
+      the Work or Derivative Works thereof, You may choose to offer,
168
+      and charge a fee for, acceptance of support, warranty, indemnity,
169
+      or other liability obligations and/or rights consistent with this
170
+      License. However, in accepting such obligations, You may act only
171
+      on Your own behalf and on Your sole responsibility, not on behalf
172
+      of any other Contributor, and only if You agree to indemnify,
173
+      defend, and hold each Contributor harmless for any liability
174
+      incurred by, or claims asserted against, such Contributor by reason
175
+      of your accepting any such warranty or additional liability.
176
+
177
+   END OF TERMS AND CONDITIONS
178
+
179
+   APPENDIX: How to apply the Apache License to your work.
180
+
181
+      To apply the Apache License to your work, attach the following
182
+      boilerplate notice, with the fields enclosed by brackets "[]"
183
+      replaced with your own identifying information. (Don't include
184
+      the brackets!)  The text should be enclosed in the appropriate
185
+      comment syntax for the file format. We also recommend that a
186
+      file or class name and description of purpose be included on the
187
+      same "printed page" as the copyright notice for easier
188
+      identification within third-party archives.
189
+
190
+   Copyright [yyyy] [name of copyright owner]
191
+
192
+   Licensed under the Apache License, Version 2.0 (the "License");
193
+   you may not use this file except in compliance with the License.
194
+   You may obtain a copy of the License at
195
+
196
+       http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+   Unless required by applicable law or agreed to in writing, software
199
+   distributed under the License is distributed on an "AS IS" BASIS,
200
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+   See the License for the specific language governing permissions and
202
+   limitations under the License.

+ 6
- 0
README.rst View File

@@ -0,0 +1,6 @@
1
+Zuul Base Jobs
2
+==============
3
+
4
+This repo contains a generic Zuul base job recommended for use by simple
5
+Zuul deployments, and a copy named base-test for use in testig changes to
6
+the same.

+ 12
- 0
bindep.txt View File

@@ -0,0 +1,12 @@
1
+# This is a cross-platform list tracking distribution packages needed by tests;
2
+# see http://docs.openstack.org/infra/bindep/ for additional information.
3
+
4
+# Need to build cryptography for installing ansible-lint
5
+build-essential [platform:dpkg]
6
+gcc [platform:rpm]
7
+libssl-dev [platform:dpkg]
8
+openssl-devel [platform:rpm]
9
+libffi-dev [platform:dpkg]
10
+libffi-devel [platform:rpm]
11
+python-dev [platform:dpkg]
12
+python-devel [platform:rpm]

+ 73
- 0
doc/source/conf.py View File

@@ -0,0 +1,73 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+import os
16
+import sys
17
+
18
+# -- General configuration ----------------------------------------------------
19
+
20
+# Add any Sphinx extension module names here, as strings. They can be
21
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
22
+extensions = [
23
+    'sphinx.ext.autodoc',
24
+    #'sphinx.ext.intersphinx',
25
+]
26
+
27
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
28
+# text edit cycles.
29
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
30
+
31
+# The suffix of source filenames.
32
+source_suffix = '.rst'
33
+
34
+# The master toctree document.
35
+master_doc = 'index'
36
+
37
+# General information about the project.
38
+project = u'zuul-base-jobs'
39
+copyright = u'2017, Zuul contributors'
40
+
41
+# If true, '()' will be appended to :func: etc. cross-reference text.
42
+add_function_parentheses = True
43
+
44
+# If true, the current module name will be prepended to all description
45
+# unit titles (such as .. function::).
46
+add_module_names = True
47
+
48
+# The name of the Pygments (syntax highlighting) style to use.
49
+pygments_style = 'sphinx'
50
+
51
+# -- Options for HTML output --------------------------------------------------
52
+
53
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
54
+# Sphinx are currently 'default' and 'sphinxdoc'.
55
+# html_theme_path = ["."]
56
+# html_theme = '_theme'
57
+# html_static_path = ['static']
58
+
59
+# Output file base name for HTML help builder.
60
+htmlhelp_basename = '%sdoc' % project
61
+
62
+# Grouping the document tree into LaTeX files. List of tuples
63
+# (source start file, target name, title, author, documentclass
64
+# [howto/manual]).
65
+latex_documents = [
66
+    ('index',
67
+     '%s.tex' % project,
68
+     u'%s Documentation' % project,
69
+     u'OpenStack Foundation', 'manual'),
70
+]
71
+
72
+# Example configuration for intersphinx: refer to the Python standard library.
73
+#intersphinx_mapping = {'http://docs.python.org/': None}

+ 11
- 0
doc/source/index.rst View File

@@ -0,0 +1,11 @@
1
+.. include:: ../../README.rst
2
+
3
+
4
+.. toctree::
5
+   :maxdepth: 2
6
+
7
+Indices and tables
8
+==================
9
+
10
+* :ref:`genindex`
11
+* :ref:`search`

+ 21
- 0
setup.cfg View File

@@ -0,0 +1,21 @@
1
+[metadata]
2
+name = zuul-base-jobs
3
+summary = A generic Zuul base job
4
+description-file =
5
+    README.rst
6
+author = OpenStack Infrastructure Team
7
+author-email = openstack-infra@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
10
+    Environment :: OpenStack
11
+    Intended Audience :: Information Technology
12
+    Intended Audience :: System Administrators
13
+    License :: OSI Approved :: Apache Software License
14
+    Operating System :: POSIX :: Linux
15
+    Programming Language :: Python
16
+
17
+[build_sphinx]
18
+all-files = 1
19
+warning-is-error = 1
20
+source-dir = doc/source
21
+build-dir = doc/build

+ 28
- 0
setup.py View File

@@ -0,0 +1,28 @@
1
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#    http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12
+# implied.
13
+# See the License for the specific language governing permissions and
14
+# limitations under the License.
15
+
16
+import setuptools
17
+
18
+# In python < 2.7.4, a lazy loading of package `pbr` will break
19
+# setuptools if some other modules registered functions in `atexit`.
20
+# solution from: http://bugs.python.org/issue15881#msg170215
21
+try:
22
+    import multiprocessing  # noqa
23
+except ImportError:
24
+    pass
25
+
26
+setuptools.setup(
27
+    setup_requires=['pbr>=2.0'],
28
+    pbr=True)

+ 11
- 0
test-requirements.txt View File

@@ -0,0 +1,11 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+flake8
5
+
6
+# We need to pin Ansible to <2.4 until Zuul supports it, otherwise ansible-lint
7
+# picks the latest version which is not known to work yet.
8
+ansible<2.4
9
+ansible-lint
10
+bashate>=0.2
11
+zuul-sphinx>=0.1.1

+ 37
- 0
tox.ini View File

@@ -0,0 +1,37 @@
1
+[tox]
2
+minversion = 1.6
3
+skipsdist = True
4
+envlist = linters
5
+
6
+[testenv]
7
+basepython = python3
8
+install_command = pip install {opts} {packages}
9
+deps = -r{toxinidir}/test-requirements.txt
10
+commands =
11
+  python setup.py testr --slowest --testr-args='{posargs}'
12
+
13
+[testenv:bindep]
14
+# Do not install any requirements. We want this to be fast and work even if
15
+# system dependencies are missing, since it's used to tell you what system
16
+# dependencies are missing! This also means that bindep must be installed
17
+# separately, outside of the requirements files.
18
+deps = bindep
19
+commands = bindep test
20
+
21
+[testenv:docs]
22
+commands = python setup.py build_sphinx
23
+
24
+[testenv:linters]
25
+commands =
26
+  flake8 {posargs}
27
+
28
+[testenv:venv]
29
+commands = {posargs}
30
+
31
+[flake8]
32
+# These are ignored intentionally in openstack-infra projects;
33
+# please don't submit patches that solely correct them or enable them.
34
+# E402 - ansible modules put documentation before imports. Align to ansible.
35
+ignore = E125,E129,E402,H
36
+show-source = True
37
+exclude = .venv,.tox,dist,doc,build,*.egg

Loading…
Cancel
Save