hacking 4.1.0 release

meta:version: 4.1.0
meta:diff-start: -
meta:series: independent
meta:release-type: release
meta:pypi: yes
meta:first: no
meta:release:Author: Martin Kopec <mkopec@redhat.com>
meta:release:Commit: Martin Kopec <mkopec@redhat.com>
meta:release:Change-Id: I04c7cf66669501ee76986ba5ee726a3f86cfa87e
meta:release:Code-Review+1: Ghanshyam <gmann@ghanshyammann.com>
meta:release:Code-Review+1: Sorin Sbârnea <ssbarnea@redhat.com>
meta:release:Code-Review+1: Radosław Piliszek <radoslaw.piliszek@gmail.com>
meta:release:Code-Review+2: Thierry Carrez <thierry@openstack.org>
meta:release:Code-Review+2: Hervé Beraud <herveberaud.pro@gmail.com>
meta:release:Code-Review+2: Elod Illes <elod.illes@est.tech>
meta:release:Workflow+1: Elod Illes <elod.illes@est.tech>

This allows hacking to be used the same way flake8 is used as
a pre-commit hook. This allows repository owners to control bumping
using `pre-commit auto-update` when they feel appropriate.

Change-Id: Id00b79ff3006c390f925dcc5031ac503374cf9bd
Needed-By: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/783828

- bump template to wallaby to make use of py39 job
- advertise py39 support in metadata
- clean default tox envlist to be python version agnostic

Change-Id: I47ce403f35460bcf27d044450c7e6ed00cda7c4f

Hacking PyPI presence does miss to expose few essential links related
to the project, so we add them to avoid forcing users to dig into
the documentation to find them.

Change-Id: I534ca4509bdb5f6846a41bf7cd25dd1773abaca7

As discussed in ML and TC meeting, lower bound
testing is optional and its up to projects to
maintain it or drop it.

- http://lists.openstack.org/pipermail/openstack-discuss/2021-March/021204.html

Change-Id: I41f876ab7363f05a0f912a65d1484b10d5613a3e

The patch bumps min version of tox to 3.18.0 python in order to
replace tox's whitelist_externals by allowlist_externals option:
https://github.com/tox-dev/tox/blob/master/docs/changelog.rst#v3180-2020-07-23

Change-Id: Ic73f1212d3a4a7178a7c735dae696bb9b8792d84

There is an ongoing discussion in ML to drop the
lower-constraints job [1].

Moving it to Non-voting until any decision is being
made in TC meeting.

[1]: http://lists.openstack.org/pipermail/openstack-discuss/2021-January/019672.html

Change-Id: Ia091d020641766089786cf6995e0c7a92f159a84

Many projects use mocking in their unit tests, and most do not realize
that there is a difference between "import mock" and "import
unittest.mock", assuming that both use a standard part of the Python
library.

We've seen many cases where mock is not listed in the project's
requirements, but the code imports the third party mock instead of
unittest.mock. We've also seen a few break due to this, once their
dependencies have stopped pulling in that package for them.

There have also been several projects that have taken the effort to
switch all of there "import mock" statements over to "import
unittest.mock", as well as removing mock from their requirements, only
to then accidentally merge a patch that does "import mock" again because
it is hard to notice in code reviews.

This check is on by default. If a project is using the mock lib, then
they are able to explicitly do so by disabling this check. Otherwise,
projects don't need to take any action to get this protection, since
this is now the recommended default.

Change-Id: I8d255a00792a19279074703a8209a3699b480fd0
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

Change-Id: I98b3b0e257172c6d43f5dd4b0d9147fc154bd5e6

This adds checking for using .format() instead of % when looking for
cases of preformatting log strings.

Change-Id: Ia12f898ca3d206c9da0e5057c7223e124ee2548c
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

We have added a check to make sure format strings and any args are being
passed in to be formatted as needed by the logger. The check did not
take into account string formatting that may be needed in preparing the
value args. There are some cases where this is needed, and we should not
be raising an error if the string formatting is being done there.

This adds a new test string and updates the hacking check to account for
these cases so the new hacking release does not raise unnecessary
errors.

Change-Id: Ie4e3f95d24dc954deb7336835a6f9b7bf54c9674
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

This patch will copy the most common hacking rules used in diff.
projects and add them to hacking itself.

Currently, added assert_true_instance, assert_equal_type
assert_raises_regexp, assert_true_or_false_with_in
assert_equal_in

Change-Id: I122d250cab90964c346e9d53046a97c25054bc00

Hacking check was failing to match on lines that should have been
flagged an issue. This fixes the check and adds unit tests to validate
the check is working as expected.

Change-Id: I20e3b54a0c5830565e5d4bbb3bbc8b4921c82fb2
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

The regex for this check was wrong, resulting in misses. This fixes the
checks for string interpolation and adds unit tests to make sure we are
actually handling the cases we expect to be.

Change-Id: Id61094bb8ee8e93275c51c53caeb9ca27252b144
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

As per victoria cycle testing runtime and community goal[1]
we need to migrate upstream CI/CD to Ubuntu Focal(20.04).

Fixing:
- bug#1886296
Bump the flake8 to 3.8.0 as min so that pyflakes 2.1.1 as min version taken
care to run pep8 jobs on py3.8 which is default python vesion in ubuntu focal.
- https://github.com/PyCQA/flake8/blob/3.8.0/setup.cfg#L44

Story: #2007865
Task: #40212

Closes-Bug: #1886296
[1] https://governance.openstack.org/tc/goals/selected/victoria/migrate-ci-cd-jobs-to-ubuntu-focal.html

Change-Id: I19b13d5d63bce0f6b646972b09cfe8e8d7c22adc

The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we don't need it
in lower-constraints and requirements.

These changes will help us to drop `mock` from openstack/requirements

Change-Id: I71a09f2eddd3a344225cb69f9679e99fdeb3e2db

It is difficult to keep the py35 upper constraints on reqiorements
repo's upper-constarint.txt file as update-constraint tools generate
the new file everytime with official supported python version only
which is py3.6 and py3.8 for Victoria cycle
- https://review.opendev.org/#/c/730428

Let's keep the py3.5 constraints in-tree which can be used in py35
unit test job.

Change-Id: I397edb7eccdb23656d1a618635d9cb9c0c901d39

This partially reverts commit 7d496330.

Depends-On: https://review.opendev.org/#/c/729306/

Change-Id: Ic5605724f914b23aa485b1355e8f8dd25b051d86

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I8e6c4b1d09e5f56b505c6006ea048baf896444c3

This commit adds PDF documentation build target 'pdf-docs' that will
build PDF versions of our docs.

This is one of the Train community goals:

 https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Change-Id: Iae6bc9ae92fe61385c424923eaad35dc449880e9
Story: #2006070
Task: #35464

Ussuri release has capped hacking < 3.1.0 and this repo is now at 3.2.0
and ready for victoria.

Remove py35 job.

This fixes building since zipp 3.1.0 is only available for python 3.6
and newer and upper-constraints.txt requires that version, so py35 job
fails.

Remove also unneeded install_command from tox.ini.

Change-Id: I07395f5ba167e849c936ad66936237ea9d90864e

It has been disabled previously to avoid pulling in new checks.
Now it's time to re-enable it with a new release.

Change-Id: Idd80085602ddb1fcf5a8d3de449866ba25a9c046

This version has enabled some new checks and fixed old ones, so
CI jobs started failing. Cap it for now so that it can be release
a patch version and then a major version uncapping it.

Change-Id: If39298338ff69327379ef10d34efac0c6f164084

Upating the testing template from ussuri to victoria
testing runtime
- https://governance.openstack.org/tc/reference/runtimes/victoria.html

Change-Id: Ib3e5b14aee87ab90f231c69beea95701be8093cc

This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: Ia46983955ddc183824d9088c1a6c3e307af188c3