Merge pull request #10074 from shanemcd/bump-19.1.0

Bump changelog and version files for 19.1.0

.github/ISSUE_TEMPLATE.md

@@ -23,8 +23,8 @@ https://www.ansible.com/security
 
 ##### ENVIRONMENT
 * AWX version: X.Y.Z
-* AWX install method: openshift, minishift, docker on linux, docker for mac, boot2docker
-* Ansible version:  X.Y.Z
+* AWX install method: operator, developer environment
+* AWX deployment target: openshift, kubernetes, minikube
 * Operating System:
 * Web Browser:
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,7 +17,6 @@ the change does.
 <!--- Name of the module/plugin/module/task -->
  - API
  - UI
- - Installer
 
 ##### AWX VERSION
 <!--- Paste verbatim output from `make VERSION` between quotes below -->

API_STANDARDS.md

@@ -1,7 +1,7 @@
 Coding Standards and Practices
 ==============================
 
-This is not meant to be a style document so much as a practices document for ensuring performance and convention in the Ansible Tower API.
+This is not meant to be a style document so much as a practices document for ensuring performance and convention in the AWX API.
 
 Paginate Everything
 ===================

CHANGELOG.md

@@ -2,6 +2,36 @@
 
 This is a list of high-level changes for each release of AWX. A full list of commits can be found at `https://github.com/ansible/awx/releases/tag/<version>`.
 
+# 19.1.0 (May 1, 2021)
+
+- Custom inventory scripts have been removed from the API https://github.com/ansible/awx/pull/9822
+  - Old scripts can be exported via `awx-manage export_custom_scripts`
+- Fixed a bug where ad-hoc commands targeted against multiple hosts would run against only 1 host https://github.com/ansible/awx/pull/9973
+- AWX will now look for a top-level requirements.yml when installing collections / roles in project updates https://github.com/ansible/awx/pull/9945
+- Improved error handling when Container Group pods fail to launch https://github.com/ansible/awx/pull/10025
+- Added ability to set server-side password policies using Django's AUTH_PASSWORD_VALIDATORS setting https://github.com/ansible/awx/pull/9999
+- Bumped versions of Ansible Runner & AWX EE https://github.com/ansible/awx/pull/10013
+  - If you have built any custom EEs on top of awx-ee 0.1.0, you will need to rebuild on top of 0.2.0.
+- Remove legacy resource profiling code https://github.com/ansible/awx/pull/9883
+
+# 19.0.0 (April 7, 2021)
+
+- AWX now runs on Python 3.8 (https://github.com/ansible/awx/pull/8778/)
+- Fixed inventories-from-projects when running in Kubernetes (https://github.com/ansible/awx/pull/9741)
+- Fixed a bug where a slash was appended to invetory file paths in UI dropdown (https://github.com/ansible/awx/pull/9713)
+- Fix a bug with large file parsing in project sync (https://github.com/ansible/awx/pull/9627)
+- Fix k8s credentials that use a custom ca cert (https://github.com/ansible/awx/pull/9744)
+- Fix a bug that allowed a user to attempt deleting a running job (https://github.com/ansible/awx/pull/9758)
+- Fixed the Kubernetes Pod reaper to properly delete Pods launched by Receptor (https://github.com/ansible/awx/pull/9819)
+- AWX Collection Modules: added ability to set instance groups for organization, job templates, and inventories. (https://github.com/ansible/awx/pull/9804)
+- Fixed CSP violation errors on job details and job settings views (https://github.com/ansible/awx/pull/9818)
+- Added support for convergence any/all on workflow nodes (https://github.com/ansible/awx/pull/9737)
+- Fixed race condition that causes InvalidGitRepositoryError (https://github.com/ansible/awx/pull/9754)
+- Added support for Execution Environments to the Activity Stream (https://github.com/ansible/awx/issues/9308)
+- Fixed a bug that improperly formats OpenSSH keys specified in custom Credential Types (https://github.com/ansible/awx/issues/9361)
+- Fixed an HTTP 500 error for unauthenticated users (https://github.com/ansible/awx/pull/9725)
+- Added subscription wizard: https://github.com/ansible/awx/pull/9496
+
 # 18.0.0 (March 23, 2021)
 
 **IMPORTANT INSTALL AND UPGRADE NOTES**
@@ -20,20 +50,22 @@ After a herculean effort from a number of contributors, we're excited to announc
 
 Execution Environments are container images which consist of everything necessary to run a playbook within AWX, and which drive the entire management and lifecycle of playbook execution runtime in AWX: https://github.com/ansible/awx/issues/5157.  This means that going forward, AWX no longer utilizes the [bubblewrap](https://github.com/containers/bubblewrap) project for playbook isolation, but instead utilizes a container per playbook run.
 
-Much like custom virtualenvs, custom Execution Environments can be crafted to specify additional Python or system-level dependencies.  Ansible Builder outputs images you can upload to your registry which can *then* be defined in AWX and utilized for playbook runs.
+Much like custom virtualenvs, custom Execution Environments can be crafted to specify additional Python or system-level dependencies.  [Ansible Builder](https://github.com/ansible/ansible-builder) outputs images you can upload to your registry which can *then* be defined in AWX and utilized for playbook runs.
 
 To learn more about Ansible Builder and Execution Environments, see: https://www.ansible.com/blog/introduction-to-ansible-builder
 
 ### Other Notable Changes
 
 - Removed `installer` directory.
-  - The Kubernetes installer has been removed in favor of [AWX Operator](https://github.com/ansible/awx-operator).
+  - The Kubernetes installer has been removed in favor of [AWX Operator](https://github.com/ansible/awx-operator).  Official images for Operator-based installs are no longer hosted on Docker Hub, but are instead available on [Quay](https://quay.io/repository/ansible/awx?tab=tags).
   - The "Local Docker" install method has been removed in favor of the development environment. Details can be found at: https://github.com/ansible/awx/blob/devel/tools/docker-compose/README.md
 - Removal of custom virtual environments https://github.com/ansible/awx/pull/9498
   - Custom virtual environments have been replaced by Execution Environments https://github.com/ansible/awx/pull/9570
 - The default Container Group Pod definition has changed. All custom Pod specs have been reset. https://github.com/ansible/awx/commit/05ef51f710dad8f8036bc5acee4097db4adc0d71
 - Added user interface for the activity stream: https://github.com/ansible/awx/pull/9083
 - Converted many of the top-level list views (Jobs, Teams, Hosts, Inventories, Projects, and more) to a new, permanent table component for substantially increased responsiveness, usability, maintainability, and other 'ility's: https://github.com/ansible/awx/pull/8970, https://github.com/ansible/awx/pull/9182 and many others!
+- Added support for Centrify Vault (https://www.centrify.com) as a credential lookup plugin (https://github.com/ansible/awx/pull/9542)
+- Added support for namespaces in Hashicorp Vault credential plugin (https://github.com/ansible/awx/pull/9590)
 - Added click-to-expand details for job tables
 - Added search filtering to job output https://github.com/ansible/awx/pull/9208
 - Added the new migration, update, and "installation in progress" page https://github.com/ansible/awx/pull/9123

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Hi there! We're excited to have you as a contributor.
 
-Have questions about this document or anything not covered here? Come chat with us at `#ansible-awx` on irc.freenode.net, or submit your question to the [mailing list](https://groups.google.com/forum/#!forum/awx-project).
+Have questions about this document or anything not covered here? Come chat with us at `#ansible-awx` on webchat.freenode.net, or submit your question to the [mailing list](https://groups.google.com/forum/#!forum/awx-project).
 
 ## Table of contents
 
@@ -28,7 +28,7 @@ Have questions about this document or anything not covered here? Come chat with
 - You must use `git commit --signoff` for any commit to be merged, and agree that usage of --signoff constitutes agreement with the terms of [DCO 1.1](./DCO_1_1.md).
 - Take care to make sure no merge commits are in the submission, and use `git rebase` vs `git merge` for this reason.
   - If collaborating with someone else on the same branch, consider using `--force-with-lease` instead of `--force`. This will prevent you from accidentally overwriting commits pushed by someone else. For more information, see https://git-scm.com/docs/git-push#git-push---force-with-leaseltrefnamegt
-- If submitting a large code change, it's a good idea to join the `#ansible-awx` channel on irc.freenode.net, and talk about what you would like to do or add first. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed.
+- If submitting a large code change, it's a good idea to join the `#ansible-awx` channel on webchat.freenode.net, and talk about what you would like to do or add first. This not only helps everyone know what's going on, it also helps save time and effort, if the community decides some changes are needed.
 - We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions, or need assistance, please reach out to our community team at [codeofconduct@ansible.com](mailto:codeofconduct@ansible.com)
 
 ## Setting up your development environment
@@ -114,7 +114,7 @@ Fixing bugs, adding translations, and updating the documentation are always appr
 
 **NOTE**
 
-> If you work in a part of the codebase that is going through active development, your changes may be rejected, or you may be asked to `rebase`. A good idea before starting work is to have a discussion with us in the `#ansible-awx` channel on irc.freenode.net, or on the [mailing list](https://groups.google.com/forum/#!forum/awx-project).
+> If you work in a part of the codebase that is going through active development, your changes may be rejected, or you may be asked to `rebase`. A good idea before starting work is to have a discussion with us in the `#ansible-awx` channel on webchat.freenode.net, or on the [mailing list](https://groups.google.com/forum/#!forum/awx-project).
 
 **NOTE**
 
@@ -127,7 +127,7 @@ Fixes and Features for AWX will go through the Github pull request process. Subm
 Here are a few things you can do to help the visibility of your change, and increase the likelihood that it will be accepted:
 
 * No issues when running linters/code checkers
-  * Python: flake8: `(container)/awx_devel$ make flake8`
+  * Python: black: `(container)/awx_devel$ make black`
   * Javascript: JsHint: `(container)/awx_devel$ make jshint`
 * No issues from unit tests
   * Python: py.test: `(container)/awx_devel$ make test`
@@ -136,7 +136,7 @@ Here are a few things you can do to help the visibility of your change, and incr
 * Make the smallest change possible
 * Write good commit messages. See [How to write a Git commit message](https://chris.beams.io/posts/git-commit/).
 
-It's generally a good idea to discuss features with us first by engaging us in the `#ansible-awx` channel on irc.freenode.net, or on the [mailing list](https://groups.google.com/forum/#!forum/awx-project).
+It's generally a good idea to discuss features with us first by engaging us in the `#ansible-awx` channel on webchat.freenode.net, or on the [mailing list](https://groups.google.com/forum/#!forum/awx-project).
 
 We like to keep our commit history clean, and will require resubmission of pull requests that contain merge commits. Use `git pull --rebase`, rather than
 `git pull`, and `git rebase`, rather than `git merge`.

INSTALL.md

@@ -32,6 +32,9 @@ If you don't have an existing OpenShift or Kubernetes cluster, minikube is a fas
 
 To install minikube, follow the steps in their [documentation](https://minikube.sigs.k8s.io/docs/start/).
 
+:warning: NOTE |
+--- |
+If you're about to install minikube or have already installed it, please be sure you're using [Minikube v1.18.1](https://github.com/kubernetes/minikube/releases/tag/v1.18.1). There's a [bug](https://github.com/ansible/awx-operator/issues/205) right now that will not allow you to run it using Minikube v1.19.x.
 #### Starting minikube
 
 Once you have installed minikube, run the following command to start it. You may wish to customize these options.
@@ -42,10 +45,12 @@ $ minikube start --cpus=4 --memory=8g --addons=ingress
 
 #### Deploying the AWX Operator
 
-For a comprehensive overview of features, see [README.md](https://github.com/ansible/awx-operator/blob/devel/README.md) in the awx-operator repo. The following steps are the bare minimum to get AWX up and running. 
+For a comprehensive overview of features, see [README.md](https://github.com/ansible/awx-operator/blob/devel/README.md) in the awx-operator repo. The following steps are the bare minimum to get AWX up and running.
+
+Start by going to https://github.com/ansible/awx-operator/releases and making note of the latest release. Replace `<tag>` in the URL below with the version you are deploying:
 
 ```
-$ minikube kubectl -- apply -f https://raw.githubusercontent.com/ansible/awx-operator/devel/deploy/awx-operator.yaml
+$ minikube kubectl -- apply -f https://raw.githubusercontent.com/ansible/awx-operator/<tag>/deploy/awx-operator.yaml
 ```
 
 ##### Verifying the Operator Deployment
@@ -73,6 +78,8 @@ spec:
   tower_ingress_type: Ingress
 ```
 
+> If a custom AWX image is needed, see [these docs](./docs/build_awx_image.md) on how to build and use it.
+
 And then creating the AWX object in the Kubernetes API:
 
 ```

MANIFEST.in

@@ -20,7 +20,7 @@ recursive-exclude awx/ui/client *
 recursive-exclude awx/settings local_settings.py*
 include tools/scripts/request_tower_configuration.sh
 include tools/scripts/request_tower_configuration.ps1
-include tools/scripts/ansible-tower-service
+include tools/scripts/automation-controller-service
 include tools/scripts/failure-event-handler
 include tools/scripts/awx-python
 include awx/playbooks/library/mkfifo.py

Makefile

@@ -1,4 +1,4 @@
-PYTHON ?= python3
+PYTHON ?= python3.8
 PYTHON_VERSION = $(shell $(PYTHON) -c "from distutils.sysconfig import get_python_version; print(get_python_version())")
 SITELIB=$(shell $(PYTHON) -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())")
 OFFICIAL ?= no
@@ -23,7 +23,7 @@ VENV_BASE ?= /var/lib/awx/venv/
 SCL_PREFIX ?=
 CELERY_SCHEDULE_FILE ?= /var/lib/awx/beat.db
 
-DEV_DOCKER_TAG_BASE ?= gcr.io/ansible-tower-engineering
+DEV_DOCKER_TAG_BASE ?= quay.io/awx
 DEVEL_IMAGE_NAME ?= $(DEV_DOCKER_TAG_BASE)/awx_devel:$(COMPOSE_TAG)
 
 # Python packages to install only from source (not from binary wheels)
@@ -31,7 +31,7 @@ DEVEL_IMAGE_NAME ?= $(DEV_DOCKER_TAG_BASE)/awx_devel:$(COMPOSE_TAG)
 SRC_ONLY_PKGS ?= cffi,pycparser,psycopg2,twilio,pycurl
 # These should be upgraded in the AWX and Ansible venv before attempting
 # to install the actual requirements
-VENV_BOOTSTRAP ?= pip==19.3.1 setuptools==41.6.0
+VENV_BOOTSTRAP ?= pip==19.3.1 setuptools==41.6.0 wheel==0.36.2
 
 # Determine appropriate shasum command
 UNAME_S := $(shell uname -s)
@@ -65,7 +65,8 @@ I18N_FLAG_FILE = .i18n_built
 	receiver test test_unit test_coverage coverage_html \
 	dev_build release_build sdist \
 	ui-release ui-devel \
-	VERSION docker-compose-sources
+	VERSION docker-compose-sources \
+	.git/hooks/pre-commit
 
 clean-tmp:
 	rm -rf tmp/
@@ -125,7 +126,7 @@ virtualenv_awx:
 			mkdir $(VENV_BASE); \
 		fi; \
 		if [ ! -d "$(VENV_BASE)/awx" ]; then \
-			virtualenv -p $(PYTHON) $(VENV_BASE)/awx; \
+			$(PYTHON) -m venv $(VENV_BASE)/awx; \
 			$(VENV_BASE)/awx/bin/pip install $(PIP_OPTIONS) $(VENV_BOOTSTRAP); \
 		fi; \
 	fi
@@ -164,7 +165,7 @@ version_file:
 	if [ "$(VENV_BASE)" ]; then \
 		. $(VENV_BASE)/awx/bin/activate; \
 	fi; \
-	python -c "import awx; print(awx.__version__)" > /var/lib/awx/.awx_version; \
+	$(PYTHON) -c "import awx; print(awx.__version__)" > /var/lib/awx/.awx_version; \
 
 # Do any one-time init tasks.
 comma := ,
@@ -173,12 +174,7 @@ init:
 		. $(VENV_BASE)/awx/bin/activate; \
 	fi; \
 	$(MANAGEMENT_COMMAND) provision_instance --hostname=$(COMPOSE_HOST); \
-	$(MANAGEMENT_COMMAND) register_queue --queuename=tower --instance_percent=100;\
-	if [ "$(AWX_GROUP_QUEUES)" == "tower,thepentagon" ]; then \
-		$(MANAGEMENT_COMMAND) provision_instance --hostname=isolated; \
-		$(MANAGEMENT_COMMAND) register_queue --queuename='thepentagon' --hostnames=isolated --controller=tower; \
-		$(MANAGEMENT_COMMAND) generate_isolated_key > /awx_devel/awx/main/isolated/authorized_keys; \
-	fi;
+	$(MANAGEMENT_COMMAND) register_queue --queuename=tower --instance_percent=100;
 
 # Refresh development environment after pulling new code.
 refresh: clean requirements_dev version_file develop migrate
@@ -271,20 +267,13 @@ jupyter:
 reports:
 	mkdir -p $@
 
-pep8: reports
-	@(set -o pipefail && $@ | tee reports/$@.report)
+black: reports
+	@command -v black >/dev/null 2>&1 || { echo "could not find black on your PATH, you may need to \`pip install black\`, or set AWX_IGNORE_BLACK=1" && exit 1; }
+	@(set -o pipefail && $@ $(BLACK_ARGS) awx awxkit awx_collection | tee reports/$@.report)
 
-flake8: reports
-	@if [ "$(VENV_BASE)" ]; then \
-		. $(VENV_BASE)/awx/bin/activate; \
-	fi; \
-	(set -o pipefail && $@ | tee reports/$@.report)
-
-pyflakes: reports
-	@(set -o pipefail && $@ | tee reports/$@.report)
-
-pylint: reports
-	@(set -o pipefail && $@ | reports/$@.report)
+.git/hooks/pre-commit:
+	@echo "[ -z \$$AWX_IGNORE_BLACK ] && (black --check \`git diff --cached --name-only --diff-filter=AM | grep -E '\.py$\'\` || (echo 'To fix this, run \`make black\` to auto-format your code prior to commit, or set AWX_IGNORE_BLACK=1' && exit 1))" > .git/hooks/pre-commit
+	@chmod +x .git/hooks/pre-commit
 
 genschema: reports
 	$(MAKE) swagger PYTEST_ARGS="--genschema --create-db "
@@ -296,10 +285,10 @@ swagger: reports
 	fi; \
 	(set -o pipefail && py.test $(PYTEST_ARGS) awx/conf/tests/functional awx/main/tests/functional/api awx/main/tests/docs --release=$(VERSION_TARGET) | tee reports/$@.report)
 
-check: flake8 pep8 # pyflakes pylint
+check: black
 
 awx-link:
-	[ -d "/awx_devel/awx.egg-info" ] || python3 /awx_devel/setup.py egg_info_dev
+	[ -d "/awx_devel/awx.egg-info" ] || $(PYTHON) /awx_devel/setup.py egg_info_dev
 	cp -f /tmp/awx.egg-link /var/lib/awx/venv/awx/lib/python$(PYTHON_VERSION)/site-packages/awx.egg-link
 
 TEST_DIRS ?= awx/main/tests/unit awx/main/tests/functional awx/conf/tests awx/sso/tests
@@ -332,10 +321,7 @@ test_collection:
 	# Second we will load any libraries out of the virtualenv (if it's unspecified that should be ok because python should not load out of an empty directory)
 	# Finally we will add the system path so that the tests can find the ansible libraries
 
-flake8_collection:
-	flake8 awx_collection/  # Different settings, in main exclude list
-
-test_collection_all: test_collection flake8_collection
+test_collection_all: test_collection
 
 # WARNING: symlinking a collection is fundamentally unstable
 # this is for rapid development iteration with playbooks, do not use with other test targets
@@ -401,7 +387,7 @@ clean-ui:
 	rm -rf $(UI_BUILD_FLAG_FILE)
 
 awx/ui_next/node_modules:
-	$(NPM_BIN) --prefix awx/ui_next --loglevel warn --ignore-scripts install
+	$(NPM_BIN) --prefix awx/ui_next --loglevel warn install
 
 $(UI_BUILD_FLAG_FILE):
 	$(NPM_BIN) --prefix awx/ui_next --loglevel warn run compile-strings
@@ -476,18 +462,18 @@ awx/projects:
 COMPOSE_UP_OPTS ?=
 CLUSTER_NODE_COUNT ?= 1
 
-docker-compose-sources:
+docker-compose-sources: .git/hooks/pre-commit
 	ansible-playbook -i tools/docker-compose/inventory tools/docker-compose/ansible/sources.yml \
 	    -e awx_image=$(DEV_DOCKER_TAG_BASE)/awx_devel \
 	    -e awx_image_tag=$(COMPOSE_TAG) \
 	    -e cluster_node_count=$(CLUSTER_NODE_COUNT)
 
 docker-compose: docker-auth awx/projects docker-compose-sources
-	docker-compose -f tools/docker-compose/_sources/docker-compose.yml $(COMPOSE_UP_OPTS) up
+	docker-compose -f tools/docker-compose/_sources/docker-compose.yml up $(COMPOSE_UP_OPTS)
 
 docker-compose-credential-plugins: docker-auth awx/projects docker-compose-sources
 	echo -e "\033[0;31mTo generate a CyberArk Conjur API key: docker exec -it tools_conjur_1 conjurctl account create quick-start\033[0m"
-	docker-compose -f tools/docker-compose/_sources/docker-compose.yml -f tools/docker-credential-plugins-override.yml up --no-recreate awx
+	docker-compose -f tools/docker-compose/_sources/docker-compose.yml -f tools/docker-credential-plugins-override.yml up --no-recreate awx_1
 
 docker-compose-test: docker-auth awx/projects docker-compose-sources
 	docker-compose -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports awx_1 /bin/bash

README.md

@@ -3,7 +3,7 @@
 
 <img src="https://raw.githubusercontent.com/ansible/awx-logos/master/awx/ui/client/assets/logo-login.svg?sanitize=true" width=200 alt="AWX" />
 
-AWX provides a web-based user interface, REST API, and task engine built on top of [Ansible](https://github.com/ansible/ansible). It is the upstream project for [Tower](https://www.ansible.com/tower), a commercial derivative of AWX.  
+AWX provides a web-based user interface, REST API, and task engine built on top of [Ansible](https://github.com/ansible/ansible). It is one of the upstream projects for [Red Hat Ansible Automation Platform](https://www.ansible.com/products/automation-platform).
 
 To install AWX, please view the [Install guide](./INSTALL.md).
 
@@ -20,7 +20,7 @@ Contributing
 - All code submissions are made through pull requests against the `devel` branch.
 - All contributors must use git commit --signoff for any commit to be merged and agree that usage of --signoff constitutes agreement with the terms of [DCO 1.1](./DCO_1_1.md)
 - Take care to make sure no merge commits are in the submission, and use `git rebase` vs. `git merge` for this reason.
-- If submitting a large code change, it's a good idea to join the `#ansible-awx` channel on irc.freenode.net and talk about what you would like to do or add first. This not only helps everyone know what's going on, but it also helps save time and effort if the community decides some changes are needed.
+- If submitting a large code change, it's a good idea to join the `#ansible-awx` channel on webchat.freenode.net and talk about what you would like to do or add first. This not only helps everyone know what's going on, but it also helps save time and effort if the community decides some changes are needed.
 
 Reporting Issues
 ----------------
@@ -37,5 +37,5 @@ Get Involved
 
 We welcome your feedback and ideas. Here's how to reach us with feedback and questions:
 
-- Join the `#ansible-awx` channel on irc.freenode.net
+- Join the `#ansible-awx` channel on webchat.freenode.net
 - Join the [mailing list](https://groups.google.com/forum/#!forum/awx-project) 

VERSION

@@ -1 +1 @@
-18.0.0
+19.1.0

awx/__init__.py

@@ -15,9 +15,10 @@ __all__ = ['__version__']
 # Check for the presence/absence of "devonly" module to determine if running
 # from a source code checkout or release packaage.
 try:
-    import awx.devonly # noqa
+    import awx.devonly  # noqa
+
     MODE = 'development'
-except ImportError: # pragma: no cover
+except ImportError:  # pragma: no cover
     MODE = 'production'
 
 
@@ -25,6 +26,7 @@ import hashlib
 
 try:
     import django  # noqa: F401
+
     HAS_DJANGO = True
 except ImportError:
     HAS_DJANGO = False
@@ -40,6 +42,7 @@ if HAS_DJANGO is True:
     try:
         names_digest('foo', 'bar', 'baz', length=8)
     except ValueError:
+
         def names_digest(*args, length):
             """
             Generate a 32-bit digest of a set of arguments that can be used to shorten
@@ -64,7 +67,7 @@ def find_commands(management_dir):
                 continue
             elif f.endswith('.py') and f[:-3] not in commands:
                 commands.append(f[:-3])
-            elif f.endswith('.pyc') and f[:-4] not in commands: # pragma: no cover
+            elif f.endswith('.pyc') and f[:-4] not in commands:  # pragma: no cover
                 commands.append(f[:-4])
     except OSError:
         pass
@@ -75,13 +78,14 @@ def oauth2_getattribute(self, attr):
     # Custom method to override
     # oauth2_provider.settings.OAuth2ProviderSettings.__getattribute__
     from django.conf import settings
+
     val = None
     if 'migrate' not in sys.argv:
         # certain Django OAuth Toolkit migrations actually reference
         # setting lookups for references to model classes (e.g.,
         # oauth2_settings.REFRESH_TOKEN_MODEL)
         # If we're doing an OAuth2 setting lookup *while running* a migration,
-        # don't do our usual "Configure Tower in Tower" database setting lookup
+        # don't do our usual database settings lookup
         val = settings.OAUTH2_PROVIDER.get(attr)
     if val is None:
         val = object.__getattribute__(self, attr)
@@ -94,33 +98,38 @@ def prepare_env():
     # Hide DeprecationWarnings when running in production.  Need to first load
     # settings to apply our filter after Django's own warnings filter.
     from django.conf import settings
-    if not settings.DEBUG: # pragma: no cover
+
+    if not settings.DEBUG:  # pragma: no cover
         warnings.simplefilter('ignore', DeprecationWarning)
     # Monkeypatch Django find_commands to also work with .pyc files.
     import django.core.management
+
     django.core.management.find_commands = find_commands
 
     # Monkeypatch Oauth2 toolkit settings class to check for settings
     # in django.conf settings each time, not just once during import
     import oauth2_provider.settings
+
     oauth2_provider.settings.OAuth2ProviderSettings.__getattribute__ = oauth2_getattribute
 
     # Use the AWX_TEST_DATABASE_* environment variables to specify the test
     # database settings to use when management command is run as an external
     # program via unit tests.
-    for opt in ('ENGINE', 'NAME', 'USER', 'PASSWORD', 'HOST', 'PORT'): # pragma: no cover
+    for opt in ('ENGINE', 'NAME', 'USER', 'PASSWORD', 'HOST', 'PORT'):  # pragma: no cover
         if os.environ.get('AWX_TEST_DATABASE_%s' % opt, None):
             settings.DATABASES['default'][opt] = os.environ['AWX_TEST_DATABASE_%s' % opt]
     # Disable capturing all SQL queries in memory when in DEBUG mode.
     if settings.DEBUG and not getattr(settings, 'SQL_DEBUG', True):
         from django.db.backends.base.base import BaseDatabaseWrapper
         from django.db.backends.utils import CursorWrapper
+
         BaseDatabaseWrapper.make_debug_cursor = lambda self, cursor: CursorWrapper(cursor, self)
 
     # Use the default devserver addr/port defined in settings for runserver.
     default_addr = getattr(settings, 'DEVSERVER_DEFAULT_ADDR', '127.0.0.1')
     default_port = getattr(settings, 'DEVSERVER_DEFAULT_PORT', 8000)
     from django.core.management.commands import runserver as core_runserver
+
     original_handle = core_runserver.Command.handle
 
     def handle(self, *args, **options):
@@ -139,7 +148,8 @@ def manage():
     # Now run the command (or display the version).
     from django.conf import settings
     from django.core.management import execute_from_command_line
-    if len(sys.argv) >= 2 and sys.argv[1] in ('version', '--version'): # pragma: no cover
+
+    if len(sys.argv) >= 2 and sys.argv[1] in ('version', '--version'):  # pragma: no cover
         sys.stdout.write('%s\n' % __version__)
     # If running as a user without permission to read settings, display an
     # error message.  Allow --help to still work.

awx/api/authentication.py

@@ -18,7 +18,6 @@ logger = logging.getLogger('awx.api.authentication')
 
 
 class LoggedBasicAuthentication(authentication.BasicAuthentication):
-
     def authenticate(self, request):
         if not settings.AUTH_BASIC_ENABLED:
             return
@@ -35,22 +34,18 @@ class LoggedBasicAuthentication(authentication.BasicAuthentication):
 
 
 class SessionAuthentication(authentication.SessionAuthentication):
-    
     def authenticate_header(self, request):
         return 'Session'
 
 
 class LoggedOAuth2Authentication(OAuth2Authentication):
-
     def authenticate(self, request):
         ret = super(LoggedOAuth2Authentication, self).authenticate(request)
         if ret:
             user, token = ret
             username = user.username if user else '<none>'
-            logger.info(smart_text(
-                u"User {} performed a {} to {} through the API using OAuth 2 token {}.".format(
-                    username, request.method, request.path, token.pk
-                )
-            ))
+            logger.info(
+                smart_text(u"User {} performed a {} to {} through the API using OAuth 2 token {}.".format(username, request.method, request.path, token.pk))
+            )
             setattr(user, 'oauth_scopes', [x for x in token.scope.split() if x])
         return ret

awx/api/conf.py

@@ -38,16 +38,20 @@ register(
 register(
     'OAUTH2_PROVIDER',
     field_class=OAuth2ProviderField,
-    default={'ACCESS_TOKEN_EXPIRE_SECONDS': oauth2_settings.ACCESS_TOKEN_EXPIRE_SECONDS,
-             'AUTHORIZATION_CODE_EXPIRE_SECONDS': oauth2_settings.AUTHORIZATION_CODE_EXPIRE_SECONDS,
-             'REFRESH_TOKEN_EXPIRE_SECONDS': oauth2_settings.REFRESH_TOKEN_EXPIRE_SECONDS},
+    default={
+        'ACCESS_TOKEN_EXPIRE_SECONDS': oauth2_settings.ACCESS_TOKEN_EXPIRE_SECONDS,
+        'AUTHORIZATION_CODE_EXPIRE_SECONDS': oauth2_settings.AUTHORIZATION_CODE_EXPIRE_SECONDS,
+        'REFRESH_TOKEN_EXPIRE_SECONDS': oauth2_settings.REFRESH_TOKEN_EXPIRE_SECONDS,
+    },
     label=_('OAuth 2 Timeout Settings'),
-    help_text=_('Dictionary for customizing OAuth 2 timeouts, available items are '
-                '`ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number '
-                'of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of '
-                'authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, '
-                'the duration of refresh tokens, after expired access tokens, '
-                'in the number of seconds.'),
+    help_text=_(
+        'Dictionary for customizing OAuth 2 timeouts, available items are '
+        '`ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number '
+        'of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of '
+        'authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, '
+        'the duration of refresh tokens, after expired access tokens, '
+        'in the number of seconds.'
+    ),
     category=_('Authentication'),
     category_slug='authentication',
     unit=_('seconds'),
@@ -57,10 +61,12 @@ register(
     field_class=fields.BooleanField,
     default=False,
     label=_('Allow External Users to Create OAuth2 Tokens'),
-    help_text=_('For security reasons, users from external auth providers (LDAP, SAML, '
-                'SSO, Radius, and others) are not allowed to create OAuth2 tokens. '
-                'To change this behavior, enable this setting. Existing tokens will '
-                'not be deleted when this setting is toggled off.'),
+    help_text=_(
+        'For security reasons, users from external auth providers (LDAP, SAML, '
+        'SSO, Radius, and others) are not allowed to create OAuth2 tokens. '
+        'To change this behavior, enable this setting. Existing tokens will '
+        'not be deleted when this setting is toggled off.'
+    ),
     category=_('Authentication'),
     category_slug='authentication',
 )
@@ -71,8 +77,7 @@ register(
     required=False,
     default='',
     label=_('Login redirect override URL'),
-    help_text=_('URL to which unauthorized users will be redirected to log in. '
-                'If blank, users will be sent to the Tower login page.'),
+    help_text=_('URL to which unauthorized users will be redirected to log in.  If blank, users will be sent to the login page.'),
     category=_('Authentication'),
     category_slug='authentication',
 )

awx/api/exceptions.py

@@ -16,7 +16,4 @@ class ActiveJobConflict(ValidationError):
         # turn everything in self.detail into string by using force_text.
         # Declare detail afterwards circumvent this behavior.
         super(ActiveJobConflict, self).__init__()
-        self.detail = {
-            "error": _("Resource is being used by running jobs."),
-            "active_jobs": active_jobs
-        }
+        self.detail = {"error": _("Resource is being used by running jobs."), "active_jobs": active_jobs}

awx/api/fields.py

@@ -16,10 +16,10 @@ __all__ = ['BooleanNullField', 'CharNullField', 'ChoiceNullField', 'VerbatimFiel
 
 
 class NullFieldMixin(object):
-    '''
+    """
     Mixin to prevent shortcutting validation when we want to allow null input,
     but coerce the resulting value to another type.
-    '''
+    """
 
     def validate_empty_values(self, data):
         (is_empty_value, data) = super(NullFieldMixin, self).validate_empty_values(data)
@@ -29,18 +29,18 @@ class NullFieldMixin(object):
 
 
 class BooleanNullField(NullFieldMixin, serializers.NullBooleanField):
-    '''
+    """
     Custom boolean field that allows null and empty string as False values.
-    '''
+    """
 
     def to_internal_value(self, data):
         return bool(super(BooleanNullField, self).to_internal_value(data))
 
 
 class CharNullField(NullFieldMixin, serializers.CharField):
-    '''
+    """
     Custom char field that allows null as input and coerces to an empty string.
-    '''
+    """
 
     def __init__(self, **kwargs):
         kwargs['allow_null'] = True
@@ -51,9 +51,9 @@ class CharNullField(NullFieldMixin, serializers.CharField):
 
 
 class ChoiceNullField(NullFieldMixin, serializers.ChoiceField):
-    '''
+    """
     Custom choice field that allows null as input and coerces to an empty string.
-    '''
+    """
 
     def __init__(self, **kwargs):
         kwargs['allow_null'] = True
@@ -64,9 +64,9 @@ class ChoiceNullField(NullFieldMixin, serializers.ChoiceField):
 
 
 class VerbatimField(serializers.Field):
-    '''
+    """
     Custom field that passes the value through without changes.
-    '''
+    """
 
     def to_internal_value(self, data):
         return data
@@ -77,22 +77,19 @@ class VerbatimField(serializers.Field):
 
 class OAuth2ProviderField(fields.DictField):
 
-    default_error_messages = {
-        'invalid_key_names': _('Invalid key names: {invalid_key_names}'),
-    }
+    default_error_messages = {'invalid_key_names': _('Invalid key names: {invalid_key_names}')}
     valid_key_names = {'ACCESS_TOKEN_EXPIRE_SECONDS', 'AUTHORIZATION_CODE_EXPIRE_SECONDS', 'REFRESH_TOKEN_EXPIRE_SECONDS'}
     child = fields.IntegerField(min_value=1)
 
     def to_internal_value(self, data):
         data = super(OAuth2ProviderField, self).to_internal_value(data)
-        invalid_flags = (set(data.keys()) - self.valid_key_names)
+        invalid_flags = set(data.keys()) - self.valid_key_names
         if invalid_flags:
             self.fail('invalid_key_names', invalid_key_names=', '.join(list(invalid_flags)))
         return data
 
 
 class DeprecatedCredentialField(serializers.IntegerField):
-
     def __init__(self, **kwargs):
         kwargs['allow_null'] = True
         kwargs['default'] = None

awx/api/filters.py

@@ -27,9 +27,9 @@ from awx.main.utils.db import get_all_field_names
 
 
 class TypeFilterBackend(BaseFilterBackend):
-    '''
+    """
     Filter on type field now returned with all objects.
-    '''
+    """
 
     def filter_queryset(self, request, queryset, view):
         try:
@@ -64,7 +64,7 @@ class TypeFilterBackend(BaseFilterBackend):
 
 
 def get_fields_from_path(model, path):
-    '''
+    """
     Given a Django ORM lookup path (possibly over multiple models)
     Returns the fields in the line, and also the revised lookup path
     ex., given
@@ -73,7 +73,7 @@ def get_fields_from_path(model, path):
     returns tuple of fields traversed as well and a corrected path,
     for special cases we do substitutions
         ([<IntegerField for timeout>], 'project__timeout')
-    '''
+    """
     # Store of all the fields used to detect repeats
     field_list = []
     new_parts = []
@@ -82,12 +82,9 @@ def get_fields_from_path(model, path):
             raise ParseError(_('No related model for field {}.').format(name))
         # HACK: Make project and inventory source filtering by old field names work for backwards compatibility.
         if model._meta.object_name in ('Project', 'InventorySource'):
-            name = {
-                'current_update': 'current_job',
-                'last_update': 'last_job',
-                'last_update_failed': 'last_job_failed',
-                'last_updated': 'last_job_run',
-            }.get(name, name)
+            name = {'current_update': 'current_job', 'last_update': 'last_job', 'last_update_failed': 'last_job_failed', 'last_updated': 'last_job_run'}.get(
+                name, name
+            )
 
         if name == 'type' and 'polymorphic_ctype' in get_all_field_names(model):
             name = 'polymorphic_ctype'
@@ -121,28 +118,42 @@ def get_fields_from_path(model, path):
 
 
 def get_field_from_path(model, path):
-    '''
+    """
     Given a Django ORM lookup path (possibly over multiple models)
     Returns the last field in the line, and the revised lookup path
     ex.
         (<IntegerField for timeout>, 'project__timeout')
-    '''
+    """
     field_list, new_path = get_fields_from_path(model, path)
     return (field_list[-1], new_path)
 
 
 class FieldLookupBackend(BaseFilterBackend):
-    '''
+    """
     Filter using field lookups provided via query string parameters.
-    '''
+    """
 
-    RESERVED_NAMES = ('page', 'page_size', 'format', 'order', 'order_by',
-                      'search', 'type', 'host_filter', 'count_disabled', 'no_truncate')
+    RESERVED_NAMES = ('page', 'page_size', 'format', 'order', 'order_by', 'search', 'type', 'host_filter', 'count_disabled', 'no_truncate')
 
-    SUPPORTED_LOOKUPS = ('exact', 'iexact', 'contains', 'icontains',
-                         'startswith', 'istartswith', 'endswith', 'iendswith',
-                         'regex', 'iregex', 'gt', 'gte', 'lt', 'lte', 'in',
-                         'isnull', 'search')
+    SUPPORTED_LOOKUPS = (
+        'exact',
+        'iexact',
+        'contains',
+        'icontains',
+        'startswith',
+        'istartswith',
+        'endswith',
+        'iendswith',
+        'regex',
+        'iregex',
+        'gt',
+        'gte',
+        'lt',
+        'lte',
+        'in',
+        'isnull',
+        'search',
+    )
 
     # A list of fields that we know can be filtered on without the possiblity
     # of introducing duplicates
@@ -189,10 +200,7 @@ class FieldLookupBackend(BaseFilterBackend):
             try:
                 return self.to_python_related(value)
             except ValueError:
-                raise ParseError(_('Invalid {field_name} id: {field_id}').format(
-                    field_name=getattr(field, 'name', 'related field'),
-                    field_id=value)
-                )
+                raise ParseError(_('Invalid {field_name} id: {field_id}').format(field_name=getattr(field, 'name', 'related field'), field_id=value))
         else:
             return field.to_python(value)
 
@@ -205,13 +213,13 @@ class FieldLookupBackend(BaseFilterBackend):
         field_list, new_lookup = self.get_fields_from_lookup(model, lookup)
         field = field_list[-1]
 
-        needs_distinct = (not all(isinstance(f, self.NO_DUPLICATES_ALLOW_LIST) for f in field_list))
+        needs_distinct = not all(isinstance(f, self.NO_DUPLICATES_ALLOW_LIST) for f in field_list)
 
         # Type names are stored without underscores internally, but are presented and
         # and serialized over the API containing underscores so we remove `_`
         # for polymorphic_ctype__model lookups.
         if new_lookup.startswith('polymorphic_ctype__model'):
-            value = value.replace('_','')
+            value = value.replace('_', '')
         elif new_lookup.endswith('__isnull'):
             value = to_python_boolean(value)
         elif new_lookup.endswith('__in'):
@@ -329,24 +337,20 @@ class FieldLookupBackend(BaseFilterBackend):
                 args = []
                 for n, k, v in and_filters:
                     if n:
-                        args.append(~Q(**{k:v}))
+                        args.append(~Q(**{k: v}))
                     else:
-                        args.append(Q(**{k:v}))
+                        args.append(Q(**{k: v}))
                 for role_name in role_filters:
                     if not hasattr(queryset.model, 'accessible_pk_qs'):
-                        raise ParseError(_(
-                            'Cannot apply role_level filter to this list because its model '
-                            'does not use roles for access control.'))
-                    args.append(
-                        Q(pk__in=queryset.model.accessible_pk_qs(request.user, role_name))
-                    )
+                        raise ParseError(_('Cannot apply role_level filter to this list because its model ' 'does not use roles for access control.'))
+                    args.append(Q(pk__in=queryset.model.accessible_pk_qs(request.user, role_name)))
                 if or_filters:
                     q = Q()
-                    for n,k,v in or_filters:
+                    for n, k, v in or_filters:
                         if n:
-                            q |= ~Q(**{k:v})
+                            q |= ~Q(**{k: v})
                         else:
-                            q |= Q(**{k:v})
+                            q |= Q(**{k: v})
                     args.append(q)
                 if search_filters and search_filter_relation == 'OR':
                     q = Q()
@@ -360,11 +364,11 @@ class FieldLookupBackend(BaseFilterBackend):
                         for constrain in constrains:
                             q_chain |= Q(**{constrain: term})
                         queryset = queryset.filter(q_chain)
-                for n,k,v in chain_filters:
+                for n, k, v in chain_filters:
                     if n:
-                        q = ~Q(**{k:v})
+                        q = ~Q(**{k: v})
                     else:
-                        q = Q(**{k:v})
+                        q = Q(**{k: v})
                     queryset = queryset.filter(q)
                 queryset = queryset.filter(*args)
                 if needs_distinct:
@@ -377,9 +381,9 @@ class FieldLookupBackend(BaseFilterBackend):
 
 
 class OrderByBackend(BaseFilterBackend):
-    '''
+    """
     Filter to apply ordering based on query string parameters.
-    '''
+    """
 
     def filter_queryset(self, request, queryset, view):
         try:

awx/api/generics.py

@@ -35,55 +35,50 @@ from rest_framework.negotiation import DefaultContentNegotiation
 
 # AWX
 from awx.api.filters import FieldLookupBackend
-from awx.main.models import (
-    UnifiedJob, UnifiedJobTemplate, User, Role, Credential,
-    WorkflowJobTemplateNode, WorkflowApprovalTemplate
-)
+from awx.main.models import UnifiedJob, UnifiedJobTemplate, User, Role, Credential, WorkflowJobTemplateNode, WorkflowApprovalTemplate
 from awx.main.access import access_registry
-from awx.main.utils import (
-    camelcase_to_underscore,
-    get_search_fields,
-    getattrd,
-    get_object_or_400,
-    decrypt_field,
-    get_awx_version,
-)
+from awx.main.utils import camelcase_to_underscore, get_search_fields, getattrd, get_object_or_400, decrypt_field, get_awx_version
 from awx.main.utils.db import get_all_field_names
 from awx.main.views import ApiErrorView
 from awx.api.serializers import ResourceAccessListElementSerializer, CopySerializer, UserSerializer
 from awx.api.versioning import URLPathVersioning
 from awx.api.metadata import SublistAttachDetatchMetadata, Metadata
 
-__all__ = ['APIView', 'GenericAPIView', 'ListAPIView', 'SimpleListAPIView',
-           'ListCreateAPIView', 'SubListAPIView', 'SubListCreateAPIView',
-           'SubListDestroyAPIView',
-           'SubListCreateAttachDetachAPIView', 'RetrieveAPIView',
-           'RetrieveUpdateAPIView', 'RetrieveDestroyAPIView',
-           'RetrieveUpdateDestroyAPIView',
-           'SubDetailAPIView',
-           'ResourceAccessList',
-           'ParentMixin',
-           'DeleteLastUnattachLabelMixin',
-           'SubListAttachDetachAPIView',
-           'CopyAPIView', 'BaseUsersList',]
+__all__ = [
+    'APIView',
+    'GenericAPIView',
+    'ListAPIView',
+    'SimpleListAPIView',
+    'ListCreateAPIView',
+    'SubListAPIView',
+    'SubListCreateAPIView',
+    'SubListDestroyAPIView',
+    'SubListCreateAttachDetachAPIView',
+    'RetrieveAPIView',
+    'RetrieveUpdateAPIView',
+    'RetrieveDestroyAPIView',
+    'RetrieveUpdateDestroyAPIView',
+    'SubDetailAPIView',
+    'ResourceAccessList',
+    'ParentMixin',
+    'DeleteLastUnattachLabelMixin',
+    'SubListAttachDetachAPIView',
+    'CopyAPIView',
+    'BaseUsersList',
+]
 
 logger = logging.getLogger('awx.api.generics')
 analytics_logger = logging.getLogger('awx.analytics.performance')
 
 
 class LoggedLoginView(auth_views.LoginView):
-
     def get(self, request, *args, **kwargs):
         # The django.auth.contrib login form doesn't perform the content
         # negotiation we've come to expect from DRF; add in code to catch
         # situations where Accept != text/html (or */*) and reply with
         # an HTTP 406
         try:
-            DefaultContentNegotiation().select_renderer(
-                request,
-                [StaticHTMLRenderer],
-                'html'
-            )
+            DefaultContentNegotiation().select_renderer(request, [StaticHTMLRenderer], 'html')
         except NotAcceptable:
             resp = Response(status=status.HTTP_406_NOT_ACCEPTABLE)
             resp.accepted_renderer = StaticHTMLRenderer()
@@ -96,7 +91,7 @@ class LoggedLoginView(auth_views.LoginView):
         ret = super(LoggedLoginView, self).post(request, *args, **kwargs)
         current_user = getattr(request, 'user', None)
         if request.user.is_authenticated:
-            logger.info(smart_text(u"User {} logged in from {}".format(self.request.user.username,request.META.get('REMOTE_ADDR', None))))
+            logger.info(smart_text(u"User {} logged in from {}".format(self.request.user.username, request.META.get('REMOTE_ADDR', None))))
             ret.set_cookie('userLoggedIn', 'true')
             current_user = UserSerializer(self.request.user)
             current_user = smart_text(JSONRenderer().render(current_user.data))
@@ -106,29 +101,27 @@ class LoggedLoginView(auth_views.LoginView):
             return ret
         else:
             if 'username' in self.request.POST:
-                logger.warn(smart_text(u"Login failed for user {} from {}".format(self.request.POST.get('username'),request.META.get('REMOTE_ADDR', None))))
+                logger.warn(smart_text(u"Login failed for user {} from {}".format(self.request.POST.get('username'), request.META.get('REMOTE_ADDR', None))))
             ret.status_code = 401
             return ret
 
 
 class LoggedLogoutView(auth_views.LogoutView):
-
     def dispatch(self, request, *args, **kwargs):
         original_user = getattr(request, 'user', None)
         ret = super(LoggedLogoutView, self).dispatch(request, *args, **kwargs)
         current_user = getattr(request, 'user', None)
         ret.set_cookie('userLoggedIn', 'false')
-        if (not current_user or not getattr(current_user, 'pk', True)) \
-                and current_user != original_user:
+        if (not current_user or not getattr(current_user, 'pk', True)) and current_user != original_user:
             logger.info("User {} logged out.".format(original_user.username))
         return ret
 
 
 def get_view_description(view, html=False):
-    '''Wrapper around REST framework get_view_description() to continue
+    """Wrapper around REST framework get_view_description() to continue
     to support our historical div.
 
-    '''
+    """
     desc = views.get_view_description(view, html=html)
     if html:
         desc = '<div class="description">%s</div>' % desc
@@ -138,6 +131,7 @@ def get_view_description(view, html=False):
 def get_default_schema():
     if settings.SETTINGS_MODULE == 'awx.settings.development':
         from awx.api.swagger import AutoSchema
+
         return AutoSchema()
     else:
         return views.APIView.schema
@@ -149,21 +143,23 @@ class APIView(views.APIView):
     versioning_class = URLPathVersioning
 
     def initialize_request(self, request, *args, **kwargs):
-        '''
+        """
         Store the Django REST Framework Request object as an attribute on the
         normal Django request, store time the request started.
-        '''
+        """
         self.time_started = time.time()
         if getattr(settings, 'SQL_DEBUG', False):
             self.queries_before = len(connection.queries)
 
         # If there are any custom headers in REMOTE_HOST_HEADERS, make sure
         # they respect the allowed proxy list
-        if all([
-            settings.PROXY_IP_ALLOWED_LIST,
-            request.environ.get('REMOTE_ADDR') not in settings.PROXY_IP_ALLOWED_LIST,
-            request.environ.get('REMOTE_HOST') not in settings.PROXY_IP_ALLOWED_LIST
-        ]):
+        if all(
+            [
+                settings.PROXY_IP_ALLOWED_LIST,
+                request.environ.get('REMOTE_ADDR') not in settings.PROXY_IP_ALLOWED_LIST,
+                request.environ.get('REMOTE_HOST') not in settings.PROXY_IP_ALLOWED_LIST,
+            ]
+        ):
             for custom_header in settings.REMOTE_HOST_HEADERS:
                 if custom_header.startswith('HTTP_'):
                     request.environ.pop(custom_header, None)
@@ -178,17 +174,19 @@ class APIView(views.APIView):
             request.drf_request_user = None
             self.__init_request_error__ = exc
         except UnsupportedMediaType as exc:
-            exc.detail = _('You did not use correct Content-Type in your HTTP request. '
-                           'If you are using our REST API, the Content-Type must be application/json')
+            exc.detail = _(
+                'You did not use correct Content-Type in your HTTP request. ' 'If you are using our REST API, the Content-Type must be application/json'
+            )
             self.__init_request_error__ = exc
         return drf_request
 
     def finalize_response(self, request, response, *args, **kwargs):
-        '''
+        """
         Log warning for 400 requests.  Add header with elapsed time.
-        '''
+        """
         from awx.main.utils import get_licenser
         from awx.main.utils.licensing import OpenLicense
+
         #
         # If the URL was rewritten, and we get a 404, we should entirely
         # replace the view in the request context with an ApiErrorView()
@@ -212,8 +210,12 @@ class APIView(views.APIView):
             return response
 
         if response.status_code >= 400:
-            status_msg = "status %s received by user %s attempting to access %s from %s" % \
-                         (response.status_code, request.user, request.path, request.META.get('REMOTE_ADDR', None))
+            status_msg = "status %s received by user %s attempting to access %s from %s" % (
+                response.status_code,
+                request.user,
+                request.path,
+                request.META.get('REMOTE_ADDR', None),
+            )
             if hasattr(self, '__init_request_error__'):
                 response = self.handle_exception(self.__init_request_error__)
             if response.status_code == 401:
@@ -225,7 +227,7 @@ class APIView(views.APIView):
         time_started = getattr(self, 'time_started', None)
         response['X-API-Product-Version'] = get_awx_version()
         response['X-API-Product-Name'] = 'AWX' if isinstance(get_licenser(), OpenLicense) else 'Red Hat Ansible Tower'
-        
+
         response['X-API-Node'] = settings.CLUSTER_HOST_ID
         if time_started:
             time_elapsed = time.time() - self.time_started
@@ -311,18 +313,12 @@ class APIView(views.APIView):
         return data
 
     def determine_version(self, request, *args, **kwargs):
-        return (
-            getattr(request, 'version', None),
-            getattr(request, 'versioning_scheme', None),
-        )
+        return (getattr(request, 'version', None), getattr(request, 'versioning_scheme', None))
 
     def dispatch(self, request, *args, **kwargs):
         if self.versioning_class is not None:
             scheme = self.versioning_class()
-            request.version, request.versioning_scheme = (
-                scheme.determine_version(request, *args, **kwargs),
-                scheme
-            )
+            request.version, request.versioning_scheme = (scheme.determine_version(request, *args, **kwargs), scheme)
             if 'version' in kwargs:
                 kwargs.pop('version')
         return super(APIView, self).dispatch(request, *args, **kwargs)
@@ -378,25 +374,22 @@ class GenericAPIView(generics.GenericAPIView, APIView):
         d = super(GenericAPIView, self).get_description_context()
         if hasattr(self.model, "_meta"):
             if hasattr(self.model._meta, "verbose_name"):
-                d.update({
-                    'model_verbose_name': smart_text(self.model._meta.verbose_name),
-                    'model_verbose_name_plural': smart_text(self.model._meta.verbose_name_plural),
-                })
+                d.update(
+                    {
+                        'model_verbose_name': smart_text(self.model._meta.verbose_name),
+                        'model_verbose_name_plural': smart_text(self.model._meta.verbose_name_plural),
+                    }
+                )
             serializer = self.get_serializer()
             metadata = self.metadata_class()
             metadata.request = self.request
-            for method, key in [
-                ('GET', 'serializer_fields'),
-                ('POST', 'serializer_create_fields'),
-                ('PUT', 'serializer_update_fields')
-            ]:
+            for method, key in [('GET', 'serializer_fields'), ('POST', 'serializer_create_fields'), ('PUT', 'serializer_update_fields')]:
                 d[key] = metadata.get_serializer_info(serializer, method=method)
         d['settings'] = settings
         return d
 
 
 class SimpleListAPIView(generics.ListAPIView, GenericAPIView):
-
     def get_queryset(self):
         return self.request.user.get_queryset(self.model)
 
@@ -413,9 +406,7 @@ class ListAPIView(generics.ListAPIView, GenericAPIView):
         else:
             order_field = 'name'
         d = super(ListAPIView, self).get_description_context()
-        d.update({
-            'order_field': order_field,
-        })
+        d.update({'order_field': order_field})
         return d
 
     @property
@@ -426,9 +417,13 @@ class ListAPIView(generics.ListAPIView, GenericAPIView):
     def related_search_fields(self):
         def skip_related_name(name):
             return (
-                name is None or name.endswith('_role') or name.startswith('_') or
-                name.startswith('deprecated_') or name.endswith('_set') or
-                name == 'polymorphic_ctype')
+                name is None
+                or name.endswith('_role')
+                or name.startswith('_')
+                or name.startswith('deprecated_')
+                or name.endswith('_set')
+                or name == 'polymorphic_ctype'
+            )
 
         fields = set([])
         for field in self.model._meta.fields:
@@ -482,9 +477,7 @@ class ParentMixin(object):
     def get_parent_object(self):
         if self.parent_object is not None:
             return self.parent_object
-        parent_filter = {
-            self.lookup_field: self.kwargs.get(self.lookup_field, None),
-        }
+        parent_filter = {self.lookup_field: self.kwargs.get(self.lookup_field, None)}
         self.parent_object = get_object_or_404(self.parent_model, **parent_filter)
         return self.parent_object
 
@@ -513,10 +506,12 @@ class SubListAPIView(ParentMixin, ListAPIView):
 
     def get_description_context(self):
         d = super(SubListAPIView, self).get_description_context()
-        d.update({
-            'parent_model_verbose_name': smart_text(self.parent_model._meta.verbose_name),
-            'parent_model_verbose_name_plural': smart_text(self.parent_model._meta.verbose_name_plural),
-        })
+        d.update(
+            {
+                'parent_model_verbose_name': smart_text(self.parent_model._meta.verbose_name),
+                'parent_model_verbose_name_plural': smart_text(self.parent_model._meta.verbose_name_plural),
+            }
+        )
         return d
 
     def get_queryset(self):
@@ -531,7 +526,6 @@ class SubListAPIView(ParentMixin, ListAPIView):
 
 
 class DestroyAPIView(generics.DestroyAPIView):
-
     def has_delete_permission(self, obj):
         return self.request.user.can_access(self.model, 'delete', obj)
 
@@ -545,12 +539,12 @@ class SubListDestroyAPIView(DestroyAPIView, SubListAPIView):
     """
     Concrete view for deleting everything related by `relationship`.
     """
+
     check_sub_obj_permission = True
 
     def destroy(self, request, *args, **kwargs):
         instance_list = self.get_queryset()
-        if (not self.check_sub_obj_permission and
-                not request.user.can_access(self.parent_model, 'delete', self.get_parent_object())):
+        if not self.check_sub_obj_permission and not request.user.can_access(self.parent_model, 'delete', self.get_parent_object()):
             raise PermissionDenied()
         self.perform_list_destroy(instance_list)
         return Response(status=status.HTTP_204_NO_CONTENT)
@@ -574,9 +568,7 @@ class SubListCreateAPIView(SubListAPIView, ListCreateAPIView):
 
     def get_description_context(self):
         d = super(SubListCreateAPIView, self).get_description_context()
-        d.update({
-            'parent_key': getattr(self, 'parent_key', None),
-        })
+        d.update({'parent_key': getattr(self, 'parent_key', None)})
         return d
 
     def get_queryset(self):
@@ -610,8 +602,7 @@ class SubListCreateAPIView(SubListAPIView, ListCreateAPIView):
         # attempt to deserialize the object
         serializer = self.get_serializer(data=data)
         if not serializer.is_valid():
-            return Response(serializer.errors,
-                            status=status.HTTP_400_BAD_REQUEST)
+            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
 
         # Verify we have permission to add the object as given.
         if not request.user.can_access(self.model, 'add', serializer.validated_data):
@@ -635,9 +626,7 @@ class SubListCreateAttachDetachAPIView(SubListCreateAPIView):
 
     def get_description_context(self):
         d = super(SubListCreateAttachDetachAPIView, self).get_description_context()
-        d.update({
-            "has_attach": True,
-        })
+        d.update({"has_attach": True})
         return d
 
     def attach_validate(self, request):
@@ -675,9 +664,7 @@ class SubListCreateAttachDetachAPIView(SubListCreateAPIView):
         sub = get_object_or_400(self.model, pk=sub_id)
 
         # Verify we have permission to attach.
-        if not request.user.can_access(self.parent_model, 'attach', parent, sub,
-                                       self.relationship, data,
-                                       skip_sub_obj_read_check=created):
+        if not request.user.can_access(self.parent_model, 'attach', parent, sub, self.relationship, data, skip_sub_obj_read_check=created):
             raise PermissionDenied()
 
         # Verify that the relationship to be added is valid.
@@ -716,8 +703,7 @@ class SubListCreateAttachDetachAPIView(SubListCreateAPIView):
         relationship = getattrd(parent, self.relationship)
         sub = get_object_or_400(self.model, pk=sub_id)
 
-        if not request.user.can_access(self.parent_model, 'unattach', parent,
-                                       sub, self.relationship, request.data):
+        if not request.user.can_access(self.parent_model, 'unattach', parent, sub, self.relationship, request.data):
             raise PermissionDenied()
 
         if parent_key:
@@ -735,28 +721,24 @@ class SubListCreateAttachDetachAPIView(SubListCreateAPIView):
 
     def post(self, request, *args, **kwargs):
         if not isinstance(request.data, dict):
-            return Response('invalid type for post data',
-                            status=status.HTTP_400_BAD_REQUEST)
+            return Response('invalid type for post data', status=status.HTTP_400_BAD_REQUEST)
         if 'disassociate' in request.data:
             return self.unattach(request, *args, **kwargs)
         else:
             return self.attach(request, *args, **kwargs)
 
 
-
 class SubListAttachDetachAPIView(SubListCreateAttachDetachAPIView):
-    '''
+    """
     Derived version of SubListCreateAttachDetachAPIView that prohibits creation
-    '''
+    """
+
     metadata_class = SublistAttachDetatchMetadata
 
     def post(self, request, *args, **kwargs):
         sub_id = request.data.get('id', None)
         if not sub_id:
-            return Response(
-                dict(msg=_("{} 'id' field is missing.".format(
-                    self.model._meta.verbose_name.title()))),
-                status=status.HTTP_400_BAD_REQUEST)
+            return Response(dict(msg=_("{} 'id' field is missing.".format(self.model._meta.verbose_name.title()))), status=status.HTTP_400_BAD_REQUEST)
         return super(SubListAttachDetachAPIView, self).post(request, *args, **kwargs)
 
     def update_raw_data(self, data):
@@ -768,11 +750,11 @@ class SubListAttachDetachAPIView(SubListCreateAttachDetachAPIView):
 
 
 class DeleteLastUnattachLabelMixin(object):
-    '''
+    """
     Models for which you want the last instance to be deleted from the database
     when the last disassociate is called should inherit from this class. Further,
     the model should implement is_detached()
-    '''
+    """
 
     def unattach(self, request, *args, **kwargs):
         (sub_id, res) = super(DeleteLastUnattachLabelMixin, self).unattach_validate(request)
@@ -798,7 +780,6 @@ class RetrieveAPIView(generics.RetrieveAPIView, GenericAPIView):
 
 
 class RetrieveUpdateAPIView(RetrieveAPIView, generics.RetrieveUpdateAPIView):
-
     def update(self, request, *args, **kwargs):
         self.update_filter(request, *args, **kwargs)
         return super(RetrieveUpdateAPIView, self).update(request, *args, **kwargs)
@@ -808,7 +789,7 @@ class RetrieveUpdateAPIView(RetrieveAPIView, generics.RetrieveUpdateAPIView):
         return super(RetrieveUpdateAPIView, self).partial_update(request, *args, **kwargs)
 
     def update_filter(self, request, *args, **kwargs):
-        ''' scrub any fields the user cannot/should not put/patch, based on user context.  This runs after read-only serialization filtering '''
+        '''scrub any fields the user cannot/should not put/patch, based on user context.  This runs after read-only serialization filtering'''
         pass
 
 
@@ -839,6 +820,7 @@ class ResourceAccessList(ParentMixin, ListAPIView):
 
 def trigger_delayed_deep_copy(*args, **kwargs):
     from awx.main.tasks import deep_copy_model_obj
+
     connection.on_commit(lambda: deep_copy_model_obj.delay(*args, **kwargs))
 
 
@@ -869,8 +851,7 @@ class CopyAPIView(GenericAPIView):
                     field_val[secret] = decrypt_field(obj, secret)
         elif isinstance(field_val, dict):
             for sub_field in field_val:
-                if isinstance(sub_field, str) \
-                        and isinstance(field_val[sub_field], str):
+                if isinstance(sub_field, str) and isinstance(field_val[sub_field], str):
                     field_val[sub_field] = decrypt_field(obj, field_name, sub_field)
         elif isinstance(field_val, str):
             try:
@@ -882,15 +863,11 @@ class CopyAPIView(GenericAPIView):
     def _build_create_dict(self, obj):
         ret = {}
         if self.copy_return_serializer_class:
-            all_fields = Metadata().get_serializer_info(
-                self._get_copy_return_serializer(), method='POST'
-            )
+            all_fields = Metadata().get_serializer_info(self._get_copy_return_serializer(), method='POST')
             for field_name, field_info in all_fields.items():
                 if not hasattr(obj, field_name) or field_info.get('read_only', True):
                     continue
-                ret[field_name] = CopyAPIView._decrypt_model_field_if_needed(
-                    obj, field_name, getattr(obj, field_name)
-                )
+                ret[field_name] = CopyAPIView._decrypt_model_field_if_needed(obj, field_name, getattr(obj, field_name))
         return ret
 
     @staticmethod
@@ -908,9 +885,11 @@ class CopyAPIView(GenericAPIView):
             except AttributeError:
                 continue
             # Adjust copy blocked fields here.
-            if field.name in fields_to_discard or field.name in [
-                'id', 'pk', 'polymorphic_ctype', 'unifiedjobtemplate_ptr', 'created_by', 'modified_by'
-            ] or field.name.endswith('_role'):
+            if (
+                field.name in fields_to_discard
+                or field.name in ['id', 'pk', 'polymorphic_ctype', 'unifiedjobtemplate_ptr', 'created_by', 'modified_by']
+                or field.name.endswith('_role')
+            ):
                 create_kwargs.pop(field.name, None)
                 continue
             if field.one_to_many:
@@ -926,33 +905,24 @@ class CopyAPIView(GenericAPIView):
             elif field.name == 'name' and not old_parent:
                 create_kwargs[field.name] = copy_name or field_val + ' copy'
             elif field.name in fields_to_preserve:
-                create_kwargs[field.name] = CopyAPIView._decrypt_model_field_if_needed(
-                    obj, field.name, field_val
-                )
+                create_kwargs[field.name] = CopyAPIView._decrypt_model_field_if_needed(obj, field.name, field_val)
 
         # WorkflowJobTemplateNodes that represent an approval are *special*;
         # when we copy them, we actually want to *copy* the UJT they point at
         # rather than share the template reference between nodes in disparate
         # workflows
-        if (
-            isinstance(obj, WorkflowJobTemplateNode) and
-            isinstance(getattr(obj, 'unified_job_template'), WorkflowApprovalTemplate)
-        ):
-            new_approval_template, sub_objs = CopyAPIView.copy_model_obj(
-                None, None, WorkflowApprovalTemplate,
-                obj.unified_job_template, creater
-            )
+        if isinstance(obj, WorkflowJobTemplateNode) and isinstance(getattr(obj, 'unified_job_template'), WorkflowApprovalTemplate):
+            new_approval_template, sub_objs = CopyAPIView.copy_model_obj(None, None, WorkflowApprovalTemplate, obj.unified_job_template, creater)
             create_kwargs['unified_job_template'] = new_approval_template
 
         new_obj = model.objects.create(**create_kwargs)
-        logger.debug('Deep copy: Created new object {}({})'.format(
-            new_obj, model
-        ))
+        logger.debug('Deep copy: Created new object {}({})'.format(new_obj, model))
         # Need to save separatedly because Djang-crum get_current_user would
         # not work properly in non-request-response-cycle context.
         new_obj.created_by = creater
         new_obj.save()
         from awx.main.signals import disable_activity_stream
+
         with disable_activity_stream():
             for m2m in m2m_to_preserve:
                 for related_obj in m2m_to_preserve[m2m].all():
@@ -978,8 +948,7 @@ class CopyAPIView(GenericAPIView):
         for key in create_kwargs:
             create_kwargs[key] = getattr(create_kwargs[key], 'pk', None) or create_kwargs[key]
         try:
-            can_copy = request.user.can_access(self.model, 'add', create_kwargs) and \
-                request.user.can_access(self.model, 'copy_related', obj)
+            can_copy = request.user.can_access(self.model, 'add', create_kwargs) and request.user.can_access(self.model, 'copy_related', obj)
         except PermissionDenied:
             return Response({'can_copy': False})
         return Response({'can_copy': can_copy})
@@ -998,8 +967,7 @@ class CopyAPIView(GenericAPIView):
         if not serializer.is_valid():
             return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
         new_obj, sub_objs = CopyAPIView.copy_model_obj(
-            None, None, self.model, obj, request.user, create_kwargs=create_kwargs,
-            copy_name=serializer.validated_data.get('name', '')
+            None, None, self.model, obj, request.user, create_kwargs=create_kwargs, copy_name=serializer.validated_data.get('name', '')
         )
         if hasattr(new_obj, 'admin_role') and request.user not in new_obj.admin_role.members.all():
             new_obj.admin_role.members.add(request.user)
@@ -1011,13 +979,9 @@ class CopyAPIView(GenericAPIView):
             cache.set(key, sub_objs, timeout=3600)
             permission_check_func = None
             if hasattr(type(self), 'deep_copy_permission_check_func'):
-                permission_check_func = (
-                    type(self).__module__, type(self).__name__, 'deep_copy_permission_check_func'
-                )
+                permission_check_func = (type(self).__module__, type(self).__name__, 'deep_copy_permission_check_func')
             trigger_delayed_deep_copy(
-                self.model.__module__, self.model.__name__,
-                obj.pk, new_obj.pk, request.user.pk, key,
-                permission_check_func=permission_check_func
+                self.model.__module__, self.model.__name__, obj.pk, new_obj.pk, request.user.pk, key, permission_check_func=permission_check_func
             )
         serializer = self._get_copy_return_serializer(new_obj)
         headers = {'Location': new_obj.get_absolute_url(request=request)}
@@ -1026,7 +990,7 @@ class CopyAPIView(GenericAPIView):
 
 class BaseUsersList(SubListCreateAttachDetachAPIView):
     def post(self, request, *args, **kwargs):
-        ret = super(BaseUsersList, self).post( request, *args, **kwargs)
+        ret = super(BaseUsersList, self).post(request, *args, **kwargs)
         if ret.status_code != 201:
             return ret
         try:

awx/api/metadata.py

@@ -26,20 +26,28 @@ from awx.main.fields import JSONField, ImplicitRoleField
 from awx.main.models import NotificationTemplate
 from awx.main.tasks import AWXReceptorJob
 
+# Polymorphic
+from polymorphic.models import PolymorphicModel
+
 
 class Metadata(metadata.SimpleMetadata):
-
     def get_field_info(self, field):
         field_info = OrderedDict()
         field_info['type'] = self.label_lookup[field]
         field_info['required'] = getattr(field, 'required', False)
 
         text_attrs = [
-            'read_only', 'label', 'help_text',
-            'min_length', 'max_length',
-            'min_value', 'max_value',
-            'category', 'category_slug',
-            'defined_in_file', 'unit',
+            'read_only',
+            'label',
+            'help_text',
+            'min_length',
+            'max_length',
+            'min_value',
+            'max_value',
+            'category',
+            'category_slug',
+            'defined_in_file',
+            'unit',
         ]
 
         for attr in text_attrs:
@@ -61,8 +69,9 @@ class Metadata(metadata.SimpleMetadata):
                 'type': _('Data type for this {}.'),
                 'url': _('URL for this {}.'),
                 'related': _('Data structure with URLs of related resources.'),
-                'summary_fields': _('Data structure with name/description for related resources.  '
-                                    'The output for some objects may be limited for performance reasons.'),
+                'summary_fields': _(
+                    'Data structure with name/description for related resources.  ' 'The output for some objects may be limited for performance reasons.'
+                ),
                 'created': _('Timestamp when this {} was created.'),
                 'modified': _('Timestamp when this {} was last modified.'),
             }
@@ -72,7 +81,9 @@ class Metadata(metadata.SimpleMetadata):
                 field_info['help_text'] = field_help_text[field.field_name].format(verbose_name)
 
             if field.field_name == 'type':
-                field_info['filterable'] = True
+                # Only include model classes with `type` field.
+                if issubclass(serializer.Meta.model, PolymorphicModel):
+                    field_info['filterable'] = True
             else:
                 for model_field in serializer.Meta.model._meta.fields:
                     if field.field_name == model_field.name:
@@ -101,9 +112,7 @@ class Metadata(metadata.SimpleMetadata):
             field_info['children'] = self.get_serializer_info(field)
 
         if not isinstance(field, (RelatedField, ManyRelatedField)) and hasattr(field, 'choices'):
-            choices = [
-                (choice_value, choice_name) for choice_value, choice_name in field.choices.items()
-            ]
+            choices = [(choice_value, choice_name) for choice_value, choice_name in field.choices.items()]
             if not any(choice in ('', None) for choice, _ in choices):
                 if field.allow_blank:
                     choices = [("", "---------")] + choices
@@ -131,7 +140,6 @@ class Metadata(metadata.SimpleMetadata):
             for (notification_type_name, notification_tr_name, notification_type_class) in NotificationTemplate.NOTIFICATION_TYPES:
                 field_info[notification_type_name] = notification_type_class.default_messages
 
-
         # Update type of fields returned...
         model_field = None
         if serializer and hasattr(serializer, 'Meta') and hasattr(serializer.Meta, 'model'):
@@ -149,22 +157,19 @@ class Metadata(metadata.SimpleMetadata):
             field_info['type'] = 'integer'
         elif field.field_name in ('created', 'modified'):
             field_info['type'] = 'datetime'
-        elif (
-            RelatedField in field.__class__.__bases__ or
-            isinstance(model_field, ForeignKey)
-        ):
+        elif RelatedField in field.__class__.__bases__ or isinstance(model_field, ForeignKey):
             field_info['type'] = 'id'
         elif (
-            isinstance(field, JSONField) or
-            isinstance(model_field, JSONField) or
-            isinstance(field, DRFJSONField) or
-            isinstance(getattr(field, 'model_field', None), JSONField) or
-            field.field_name == 'credential_passwords'
+            isinstance(field, JSONField)
+            or isinstance(model_field, JSONField)
+            or isinstance(field, DRFJSONField)
+            or isinstance(getattr(field, 'model_field', None), JSONField)
+            or field.field_name == 'credential_passwords'
         ):
             field_info['type'] = 'json'
         elif (
-            isinstance(field, ManyRelatedField) and
-            field.field_name == 'credentials'
+            isinstance(field, ManyRelatedField)
+            and field.field_name == 'credentials'
             # launch-time credentials
         ):
             field_info['type'] = 'list_of_ids'
@@ -175,10 +180,7 @@ class Metadata(metadata.SimpleMetadata):
 
     def get_serializer_info(self, serializer, method=None):
         filterer = getattr(serializer, 'filter_field_metadata', lambda fields, method: fields)
-        return filterer(
-            super(Metadata, self).get_serializer_info(serializer),
-            method
-        )
+        return filterer(super(Metadata, self).get_serializer_info(serializer), method)
 
     def determine_actions(self, request, view):
         # Add field information for GET requests (so field names/labels are
@@ -274,6 +276,7 @@ class Metadata(metadata.SimpleMetadata):
             metadata['object_roles'] = roles
 
         from rest_framework import generics
+
         if isinstance(view, generics.ListAPIView) and hasattr(view, 'paginator'):
             metadata['max_page_size'] = view.paginator.max_page_size
 
@@ -293,7 +296,6 @@ class RoleMetadata(Metadata):
 
 
 class SublistAttachDetatchMetadata(Metadata):
-
     def determine_actions(self, request, view):
         actions = super(SublistAttachDetatchMetadata, self).determine_actions(request, view)
         method = 'POST'

awx/api/metrics.py

@@ -3,13 +3,9 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    MetricsView
-)
+from awx.api.views import MetricsView
 
 
-urls = [
-    url(r'^$', MetricsView.as_view(), name='metrics_view'),
-]
+urls = [url(r'^$', MetricsView.as_view(), name='metrics_view')]
 
 __all__ = ['urls']

awx/api/pagination.py

@@ -10,7 +10,6 @@ from rest_framework.utils.urls import replace_query_param
 
 
 class DisabledPaginator(DjangoPaginator):
-
     @property
     def num_pages(self):
         return 1
@@ -49,8 +48,7 @@ class Pagination(pagination.PageNumberPagination):
 
     def get_html_context(self):
         context = super().get_html_context()
-        context['page_links'] = [pl._replace(url=self.cap_page_size(pl.url))
-                                 for pl in context['page_links']]
+        context['page_links'] = [pl._replace(url=self.cap_page_size(pl.url)) for pl in context['page_links']]
 
         return context
 

awx/api/permissions.py

@@ -15,16 +15,25 @@ from awx.main.utils import get_object_or_400
 
 logger = logging.getLogger('awx.api.permissions')
 
-__all__ = ['ModelAccessPermission', 'JobTemplateCallbackPermission', 'VariableDataPermission',
-           'TaskPermission', 'ProjectUpdatePermission', 'InventoryInventorySourcesUpdatePermission',
-           'UserPermission', 'IsSuperUser', 'InstanceGroupTowerPermission', 'WorkflowApprovalPermission']
+__all__ = [
+    'ModelAccessPermission',
+    'JobTemplateCallbackPermission',
+    'VariableDataPermission',
+    'TaskPermission',
+    'ProjectUpdatePermission',
+    'InventoryInventorySourcesUpdatePermission',
+    'UserPermission',
+    'IsSuperUser',
+    'InstanceGroupTowerPermission',
+    'WorkflowApprovalPermission',
+]
 
 
 class ModelAccessPermission(permissions.BasePermission):
-    '''
+    """
     Default permissions class to check user access based on the model and
     request method, optionally verifying the request data.
-    '''
+    """
 
     def check_options_permissions(self, request, view, obj=None):
         return self.check_get_permissions(request, view, obj)
@@ -35,8 +44,7 @@ class ModelAccessPermission(permissions.BasePermission):
     def check_get_permissions(self, request, view, obj=None):
         if hasattr(view, 'parent_model'):
             parent_obj = view.get_parent_object()
-            if not check_user_access(request.user, view.parent_model, 'read',
-                                     parent_obj):
+            if not check_user_access(request.user, view.parent_model, 'read', parent_obj):
                 return False
         if not obj:
             return True
@@ -45,8 +53,7 @@ class ModelAccessPermission(permissions.BasePermission):
     def check_post_permissions(self, request, view, obj=None):
         if hasattr(view, 'parent_model'):
             parent_obj = view.get_parent_object()
-            if not check_user_access(request.user, view.parent_model, 'read',
-                                     parent_obj):
+            if not check_user_access(request.user, view.parent_model, 'read', parent_obj):
                 return False
             if hasattr(view, 'parent_key'):
                 if not check_user_access(request.user, view.model, 'add', {view.parent_key: parent_obj}):
@@ -60,10 +67,7 @@ class ModelAccessPermission(permissions.BasePermission):
             extra_kwargs = {}
             if view.obj_permission_type == 'admin':
                 extra_kwargs['data'] = {}
-            return check_user_access(
-                request.user, view.model, view.obj_permission_type, obj,
-                **extra_kwargs
-            )
+            return check_user_access(request.user, view.model, view.obj_permission_type, obj, **extra_kwargs)
         else:
             if obj:
                 return True
@@ -74,8 +78,7 @@ class ModelAccessPermission(permissions.BasePermission):
             # FIXME: For some reason this needs to return True
             # because it is first called with obj=None?
             return True
-        return check_user_access(request.user, view.model, 'change', obj,
-                                 request.data)
+        return check_user_access(request.user, view.model, 'change', obj, request.data)
 
     def check_patch_permissions(self, request, view, obj=None):
         return self.check_put_permissions(request, view, obj)
@@ -89,10 +92,10 @@ class ModelAccessPermission(permissions.BasePermission):
         return check_user_access(request.user, view.model, 'delete', obj)
 
     def check_permissions(self, request, view, obj=None):
-        '''
+        """
         Perform basic permissions checking before delegating to the appropriate
         method based on the request method.
-        '''
+        """
 
         # Don't allow anonymous users. 401, not 403, hence no raised exception.
         if not request.user or request.user.is_anonymous:
@@ -117,9 +120,7 @@ class ModelAccessPermission(permissions.BasePermission):
         return result
 
     def has_permission(self, request, view, obj=None):
-        logger.debug('has_permission(user=%s method=%s data=%r, %s, %r)',
-                     request.user, request.method, request.data,
-                     view.__class__.__name__, obj)
+        logger.debug('has_permission(user=%s method=%s data=%r, %s, %r)', request.user, request.method, request.data, view.__class__.__name__, obj)
         try:
             response = self.check_permissions(request, view, obj)
         except Exception as e:
@@ -134,10 +135,10 @@ class ModelAccessPermission(permissions.BasePermission):
 
 
 class JobTemplateCallbackPermission(ModelAccessPermission):
-    '''
+    """
     Permission check used by job template callback view for requests from
     empheral hosts.
-    '''
+    """
 
     def has_permission(self, request, view, obj=None):
         # If another authentication method was used and it's not a POST, return
@@ -160,18 +161,16 @@ class JobTemplateCallbackPermission(ModelAccessPermission):
 
 
 class VariableDataPermission(ModelAccessPermission):
-
     def check_put_permissions(self, request, view, obj=None):
         if not obj:
             return True
-        return check_user_access(request.user, view.model, 'change', obj,
-                                 dict(variables=request.data))
+        return check_user_access(request.user, view.model, 'change', obj, dict(variables=request.data))
 
 
 class TaskPermission(ModelAccessPermission):
-    '''
+    """
     Permission checks used for API callbacks from running a task.
-    '''
+    """
 
     def has_permission(self, request, view, obj=None):
         # If another authentication method was used other than the one for
@@ -182,8 +181,7 @@ class TaskPermission(ModelAccessPermission):
         # Verify that the ID present in the auth token is for a valid, active
         # unified job.
         try:
-            unified_job = UnifiedJob.objects.get(status='running',
-                                                 pk=int(request.auth.split('-')[0]))
+            unified_job = UnifiedJob.objects.get(status='running', pk=int(request.auth.split('-')[0]))
         except (UnifiedJob.DoesNotExist, TypeError):
             return False
 
@@ -197,10 +195,10 @@ class TaskPermission(ModelAccessPermission):
 
 
 class WorkflowApprovalPermission(ModelAccessPermission):
-    '''
+    """
     Permission check used by workflow `approval` and `deny` views to determine
     who has access to approve and deny paused workflow nodes
-    '''
+    """
 
     def check_post_permissions(self, request, view, obj=None):
         approval = get_object_or_400(view.model, pk=view.kwargs['pk'])
@@ -208,9 +206,10 @@ class WorkflowApprovalPermission(ModelAccessPermission):
 
 
 class ProjectUpdatePermission(ModelAccessPermission):
-    '''
+    """
     Permission check used by ProjectUpdateView to determine who can update projects
-    '''
+    """
+
     def check_get_permissions(self, request, view, obj=None):
         project = get_object_or_400(view.model, pk=view.kwargs['pk'])
         return check_user_access(request.user, view.model, 'read', project)

awx/api/renderers.py

@@ -11,7 +11,6 @@ from rest_framework.utils import encoders
 
 
 class SurrogateEncoder(encoders.JSONEncoder):
-
     def encode(self, obj):
         ret = super(SurrogateEncoder, self).encode(obj)
         try:
@@ -28,9 +27,9 @@ class DefaultJSONRenderer(renderers.JSONRenderer):
 
 
 class BrowsableAPIRenderer(renderers.BrowsableAPIRenderer):
-    '''
+    """
     Customizations to the default browsable API renderer.
-    '''
+    """
 
     def get_default_renderer(self, view):
         renderer = super(BrowsableAPIRenderer, self).get_default_renderer(view)
@@ -48,9 +47,7 @@ class BrowsableAPIRenderer(renderers.BrowsableAPIRenderer):
             # see: https://github.com/ansible/awx/issues/3108
             # https://code.djangoproject.com/ticket/28121
             return data
-        return super(BrowsableAPIRenderer, self).get_content(renderer, data,
-                                                             accepted_media_type,
-                                                             renderer_context)
+        return super(BrowsableAPIRenderer, self).get_content(renderer, data, accepted_media_type, renderer_context)
 
     def get_context(self, data, accepted_media_type, renderer_context):
         # Store the associated response status to know how to populate the raw
@@ -125,18 +122,25 @@ class AnsiDownloadRenderer(PlainTextRenderer):
 
 
 class PrometheusJSONRenderer(renderers.JSONRenderer):
-
     def render(self, data, accepted_media_type=None, renderer_context=None):
         if isinstance(data, dict):
             # HTTP errors are {'detail': ErrorDetail(string='...', code=...)}
-            return super(PrometheusJSONRenderer, self).render(
-                data, accepted_media_type, renderer_context
-            )
+            return super(PrometheusJSONRenderer, self).render(data, accepted_media_type, renderer_context)
         parsed_metrics = text_string_to_metric_families(data)
         data = {}
         for family in parsed_metrics:
+            data[family.name] = {}
+            data[family.name]['help_text'] = family.documentation
+            data[family.name]['type'] = family.type
+            data[family.name]['samples'] = []
             for sample in family.samples:
-                data[sample[0]] = {"labels": sample[1], "value": sample[2]}
-        return super(PrometheusJSONRenderer, self).render(
-            data, accepted_media_type, renderer_context
-        )
+                sample_dict = {"labels": sample[1], "value": sample[2]}
+                if family.type == 'histogram':
+                    if sample[0].endswith("_sum"):
+                        sample_dict['sample_type'] = "sum"
+                    elif sample[0].endswith("_count"):
+                        sample_dict['sample_type'] = "count"
+                    elif sample[0].endswith("_bucket"):
+                        sample_dict['sample_type'] = "bucket"
+                data[family.name]['samples'].append(sample_dict)
+        return super(PrometheusJSONRenderer, self).render(data, accepted_media_type, renderer_context)

awx/api/swagger.py

@@ -14,7 +14,6 @@ from rest_framework_swagger import renderers
 
 
 class SuperUserSchemaGenerator(SchemaGenerator):
-
     def has_view_permissions(self, path, method, view):
         #
         # Generate the Swagger schema as if you were a superuser and
@@ -25,17 +24,17 @@ class SuperUserSchemaGenerator(SchemaGenerator):
 
 
 class AutoSchema(DRFAuthSchema):
-
     def get_link(self, path, method, base_url):
         link = super(AutoSchema, self).get_link(path, method, base_url)
         try:
             serializer = self.view.get_serializer()
         except Exception:
             serializer = None
-            warnings.warn('{}.get_serializer() raised an exception during '
-                          'schema generation. Serializer fields will not be '
-                          'generated for {} {}.'
-                          .format(self.view.__class__.__name__, method, path))
+            warnings.warn(
+                '{}.get_serializer() raised an exception during '
+                'schema generation. Serializer fields will not be '
+                'generated for {} {}.'.format(self.view.__class__.__name__, method, path)
+            )
 
         link.__dict__['deprecated'] = getattr(self.view, 'deprecated', False)
 
@@ -43,9 +42,7 @@ class AutoSchema(DRFAuthSchema):
         if hasattr(self.view, 'swagger_topic'):
             link.__dict__['topic'] = str(self.view.swagger_topic).title()
         elif serializer and hasattr(serializer, 'Meta'):
-            link.__dict__['topic'] = str(
-                serializer.Meta.model._meta.verbose_name_plural
-            ).title()
+            link.__dict__['topic'] = str(serializer.Meta.model._meta.verbose_name_plural).title()
         elif hasattr(self.view, 'model'):
             link.__dict__['topic'] = str(self.view.model._meta.verbose_name_plural).title()
         else:
@@ -62,18 +59,10 @@ class SwaggerSchemaView(APIView):
     _ignore_model_permissions = True
     exclude_from_schema = True
     permission_classes = [AllowAny]
-    renderer_classes = [
-        CoreJSONRenderer,
-        renderers.OpenAPIRenderer,
-        renderers.SwaggerUIRenderer
-    ]
+    renderer_classes = [CoreJSONRenderer, renderers.OpenAPIRenderer, renderers.SwaggerUIRenderer]
 
     def get(self, request):
-        generator = SuperUserSchemaGenerator(
-            title='Ansible Tower API',
-            patterns=None,
-            urlconf=None
-        )
+        generator = SuperUserSchemaGenerator(title='Ansible Automation Platform controller API', patterns=None, urlconf=None)
         schema = generator.get_schema(request=request)
         # python core-api doesn't support the deprecation yet, so track it
         # ourselves and return it in a response header
@@ -103,11 +92,6 @@ class SwaggerSchemaView(APIView):
                     schema._data[topic]._data[path] = node
 
         if not schema:
-            raise exceptions.ValidationError(
-                'The schema generator did not return a schema Document'
-            )
+            raise exceptions.ValidationError('The schema generator did not return a schema Document')
 
-        return Response(
-            schema,
-            headers={'X-Deprecated-Paths': json.dumps(_deprecated)}
-        )
+        return Response(schema, headers={'X-Deprecated-Paths': json.dumps(_deprecated)})

awx/api/templates/api/metrics_view.md

@@ -0,0 +1 @@
+query params to filter response, e.g., ?subsystemonly=1&metric=callback_receiver_events_insert_db&node=awx-1

awx/api/urls/activity_stream.py

@@ -3,10 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    ActivityStreamList,
-    ActivityStreamDetail,
-)
+from awx.api.views import ActivityStreamList, ActivityStreamDetail
 
 
 urls = [

awx/api/urls/ad_hoc_command_event.py

@@ -3,10 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    AdHocCommandEventList,
-    AdHocCommandEventDetail,
-)
+from awx.api.views import AdHocCommandEventList, AdHocCommandEventDetail
 
 
 urls = [

awx/api/urls/credential_input_source.py

@@ -3,10 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    CredentialInputSourceDetail,
-    CredentialInputSourceList,
-)
+from awx.api.views import CredentialInputSourceDetail, CredentialInputSourceList
 
 
 urls = [

awx/api/urls/credential_type.py

@@ -3,13 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    CredentialTypeList,
-    CredentialTypeDetail,
-    CredentialTypeCredentialList,
-    CredentialTypeActivityStreamList,
-    CredentialTypeExternalTest,
-)
+from awx.api.views import CredentialTypeList, CredentialTypeDetail, CredentialTypeCredentialList, CredentialTypeActivityStreamList, CredentialTypeExternalTest
 
 
 urls = [

awx/api/urls/instance.py

@@ -3,20 +3,14 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    InstanceList,
-    InstanceDetail,
-    InstanceUnifiedJobsList,
-    InstanceInstanceGroupsList,
-)
+from awx.api.views import InstanceList, InstanceDetail, InstanceUnifiedJobsList, InstanceInstanceGroupsList
 
 
 urls = [
     url(r'^$', InstanceList.as_view(), name='instance_list'),
     url(r'^(?P<pk>[0-9]+)/$', InstanceDetail.as_view(), name='instance_detail'),
     url(r'^(?P<pk>[0-9]+)/jobs/$', InstanceUnifiedJobsList.as_view(), name='instance_unified_jobs_list'),
-    url(r'^(?P<pk>[0-9]+)/instance_groups/$', InstanceInstanceGroupsList.as_view(),
-        name='instance_instance_groups_list'),
+    url(r'^(?P<pk>[0-9]+)/instance_groups/$', InstanceInstanceGroupsList.as_view(), name='instance_instance_groups_list'),
 ]
 
 __all__ = ['urls']

awx/api/urls/instance_group.py

@@ -3,12 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    InstanceGroupList,
-    InstanceGroupDetail,
-    InstanceGroupUnifiedJobsList,
-    InstanceGroupInstanceList,
-)
+from awx.api.views import InstanceGroupList, InstanceGroupDetail, InstanceGroupUnifiedJobsList, InstanceGroupInstanceList
 
 
 urls = [

awx/api/urls/inventory_script.py

@@ -1,21 +0,0 @@
-# Copyright (c) 2017 Ansible, Inc.
-# All Rights Reserved.
-
-from django.conf.urls import url
-
-from awx.api.views import (
-    InventoryScriptList,
-    InventoryScriptDetail,
-    InventoryScriptObjectRolesList,
-    InventoryScriptCopy,
-)
-
-
-urls = [
-    url(r'^$', InventoryScriptList.as_view(), name='inventory_script_list'),
-    url(r'^(?P<pk>[0-9]+)/$', InventoryScriptDetail.as_view(), name='inventory_script_detail'),
-    url(r'^(?P<pk>[0-9]+)/object_roles/$', InventoryScriptObjectRolesList.as_view(), name='inventory_script_object_roles_list'),
-    url(r'^(?P<pk>[0-9]+)/copy/$', InventoryScriptCopy.as_view(), name='inventory_script_copy'),
-]
-
-__all__ = ['urls']

awx/api/urls/inventory_source.py

@@ -29,12 +29,21 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/credentials/$', InventorySourceCredentialsList.as_view(), name='inventory_source_credentials_list'),
     url(r'^(?P<pk>[0-9]+)/groups/$', InventorySourceGroupsList.as_view(), name='inventory_source_groups_list'),
     url(r'^(?P<pk>[0-9]+)/hosts/$', InventorySourceHostsList.as_view(), name='inventory_source_hosts_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_started/$', InventorySourceNotificationTemplatesStartedList.as_view(),
-        name='inventory_source_notification_templates_started_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_error/$', InventorySourceNotificationTemplatesErrorList.as_view(),
-        name='inventory_source_notification_templates_error_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_success/$', InventorySourceNotificationTemplatesSuccessList.as_view(),
-        name='inventory_source_notification_templates_success_list'),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_started/$',
+        InventorySourceNotificationTemplatesStartedList.as_view(),
+        name='inventory_source_notification_templates_started_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_error/$',
+        InventorySourceNotificationTemplatesErrorList.as_view(),
+        name='inventory_source_notification_templates_error_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_success/$',
+        InventorySourceNotificationTemplatesSuccessList.as_view(),
+        name='inventory_source_notification_templates_success_list',
+    ),
 ]
 
 __all__ = ['urls']

awx/api/urls/job_event.py

@@ -3,12 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    JobEventList,
-    JobEventDetail,
-    JobEventChildrenList,
-    JobEventHostsList,
-)
+from awx.api.views import JobEventList, JobEventDetail, JobEventChildrenList, JobEventHostsList
 
 
 urls = [

awx/api/urls/job_host_summary.py

@@ -3,13 +3,9 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    JobHostSummaryDetail,
-)
+from awx.api.views import JobHostSummaryDetail
 
 
-urls = [
-    url(r'^(?P<pk>[0-9]+)/$', JobHostSummaryDetail.as_view(), name='job_host_summary_detail'),
-]
+urls = [url(r'^(?P<pk>[0-9]+)/$', JobHostSummaryDetail.as_view(), name='job_host_summary_detail')]
 
 __all__ = ['urls']

awx/api/urls/job_template.py

@@ -34,12 +34,21 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/schedules/$', JobTemplateSchedulesList.as_view(), name='job_template_schedules_list'),
     url(r'^(?P<pk>[0-9]+)/survey_spec/$', JobTemplateSurveySpec.as_view(), name='job_template_survey_spec'),
     url(r'^(?P<pk>[0-9]+)/activity_stream/$', JobTemplateActivityStreamList.as_view(), name='job_template_activity_stream_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_started/$', JobTemplateNotificationTemplatesStartedList.as_view(),
-        name='job_template_notification_templates_started_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_error/$', JobTemplateNotificationTemplatesErrorList.as_view(),
-        name='job_template_notification_templates_error_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_success/$', JobTemplateNotificationTemplatesSuccessList.as_view(),
-        name='job_template_notification_templates_success_list'),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_started/$',
+        JobTemplateNotificationTemplatesStartedList.as_view(),
+        name='job_template_notification_templates_started_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_error/$',
+        JobTemplateNotificationTemplatesErrorList.as_view(),
+        name='job_template_notification_templates_error_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_success/$',
+        JobTemplateNotificationTemplatesSuccessList.as_view(),
+        name='job_template_notification_templates_success_list',
+    ),
     url(r'^(?P<pk>[0-9]+)/instance_groups/$', JobTemplateInstanceGroupsList.as_view(), name='job_template_instance_groups_list'),
     url(r'^(?P<pk>[0-9]+)/access_list/$', JobTemplateAccessList.as_view(), name='job_template_access_list'),
     url(r'^(?P<pk>[0-9]+)/object_roles/$', JobTemplateObjectRolesList.as_view(), name='job_template_object_roles_list'),

awx/api/urls/label.py

@@ -3,15 +3,9 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    LabelList,
-    LabelDetail,
-)
+from awx.api.views import LabelList, LabelDetail
 
 
-urls = [
-    url(r'^$', LabelList.as_view(), name='label_list'),
-    url(r'^(?P<pk>[0-9]+)/$', LabelDetail.as_view(), name='label_detail'),
-]
+urls = [url(r'^$', LabelList.as_view(), name='label_list'), url(r'^(?P<pk>[0-9]+)/$', LabelDetail.as_view(), name='label_detail')]
 
 __all__ = ['urls']

awx/api/urls/notification.py

@@ -3,15 +3,9 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    NotificationList,
-    NotificationDetail,
-)
+from awx.api.views import NotificationList, NotificationDetail
 
 
-urls = [
-    url(r'^$', NotificationList.as_view(), name='notification_list'),
-    url(r'^(?P<pk>[0-9]+)/$', NotificationDetail.as_view(), name='notification_detail'),
-]
+urls = [url(r'^$', NotificationList.as_view(), name='notification_list'), url(r'^(?P<pk>[0-9]+)/$', NotificationDetail.as_view(), name='notification_detail')]
 
 __all__ = ['urls']

awx/api/urls/oauth2.py

@@ -16,32 +16,12 @@ from awx.api.views import (
 
 urls = [
     url(r'^applications/$', OAuth2ApplicationList.as_view(), name='o_auth2_application_list'),
-    url(
-        r'^applications/(?P<pk>[0-9]+)/$',
-        OAuth2ApplicationDetail.as_view(),
-        name='o_auth2_application_detail'
-    ),
-    url(
-        r'^applications/(?P<pk>[0-9]+)/tokens/$',
-        ApplicationOAuth2TokenList.as_view(),
-        name='o_auth2_application_token_list'
-    ),
-    url(
-        r'^applications/(?P<pk>[0-9]+)/activity_stream/$',
-        OAuth2ApplicationActivityStreamList.as_view(),
-        name='o_auth2_application_activity_stream_list'
-    ),
+    url(r'^applications/(?P<pk>[0-9]+)/$', OAuth2ApplicationDetail.as_view(), name='o_auth2_application_detail'),
+    url(r'^applications/(?P<pk>[0-9]+)/tokens/$', ApplicationOAuth2TokenList.as_view(), name='o_auth2_application_token_list'),
+    url(r'^applications/(?P<pk>[0-9]+)/activity_stream/$', OAuth2ApplicationActivityStreamList.as_view(), name='o_auth2_application_activity_stream_list'),
     url(r'^tokens/$', OAuth2TokenList.as_view(), name='o_auth2_token_list'),
-    url(
-        r'^tokens/(?P<pk>[0-9]+)/$',
-        OAuth2TokenDetail.as_view(),
-        name='o_auth2_token_detail'
-    ),
-    url(
-        r'^tokens/(?P<pk>[0-9]+)/activity_stream/$',
-        OAuth2TokenActivityStreamList.as_view(),
-        name='o_auth2_token_activity_stream_list'
-    ),   
+    url(r'^tokens/(?P<pk>[0-9]+)/$', OAuth2TokenDetail.as_view(), name='o_auth2_token_detail'),
+    url(r'^tokens/(?P<pk>[0-9]+)/activity_stream/$', OAuth2TokenActivityStreamList.as_view(), name='o_auth2_token_activity_stream_list'),
 ]
 
 __all__ = ['urls']

awx/api/urls/oauth2_root.py

@@ -10,13 +10,10 @@ from oauthlib import oauth2
 from oauth2_provider import views
 
 from awx.main.models import RefreshToken
-from awx.api.views import (
-    ApiOAuthAuthorizationRootView,
-)
+from awx.api.views import ApiOAuthAuthorizationRootView
 
 
 class TokenView(views.TokenView):
-
     def create_token_response(self, request):
         # Django OAuth2 Toolkit has a bug whereby refresh tokens are *never*
         # properly expired (ugh):
@@ -26,9 +23,7 @@ class TokenView(views.TokenView):
         # This code detects and auto-expires them on refresh grant
         # requests.
         if request.POST.get('grant_type') == 'refresh_token' and 'refresh_token' in request.POST:
-            refresh_token = RefreshToken.objects.filter(
-                token=request.POST['refresh_token']
-            ).first()
+            refresh_token = RefreshToken.objects.filter(token=request.POST['refresh_token']).first()
             if refresh_token:
                 expire_seconds = settings.OAUTH2_PROVIDER.get('REFRESH_TOKEN_EXPIRE_SECONDS', 0)
                 if refresh_token.created + timedelta(seconds=expire_seconds) < now():

awx/api/urls/organization.py

@@ -43,14 +43,26 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/credentials/$', OrganizationCredentialList.as_view(), name='organization_credential_list'),
     url(r'^(?P<pk>[0-9]+)/activity_stream/$', OrganizationActivityStreamList.as_view(), name='organization_activity_stream_list'),
     url(r'^(?P<pk>[0-9]+)/notification_templates/$', OrganizationNotificationTemplatesList.as_view(), name='organization_notification_templates_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_started/$', OrganizationNotificationTemplatesStartedList.as_view(),
-        name='organization_notification_templates_started_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_error/$', OrganizationNotificationTemplatesErrorList.as_view(),
-        name='organization_notification_templates_error_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_success/$', OrganizationNotificationTemplatesSuccessList.as_view(),
-        name='organization_notification_templates_success_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_approvals/$', OrganizationNotificationTemplatesApprovalList.as_view(),
-        name='organization_notification_templates_approvals_list'),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_started/$',
+        OrganizationNotificationTemplatesStartedList.as_view(),
+        name='organization_notification_templates_started_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_error/$',
+        OrganizationNotificationTemplatesErrorList.as_view(),
+        name='organization_notification_templates_error_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_success/$',
+        OrganizationNotificationTemplatesSuccessList.as_view(),
+        name='organization_notification_templates_success_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_approvals/$',
+        OrganizationNotificationTemplatesApprovalList.as_view(),
+        name='organization_notification_templates_approvals_list',
+    ),
     url(r'^(?P<pk>[0-9]+)/instance_groups/$', OrganizationInstanceGroupsList.as_view(), name='organization_instance_groups_list'),
     url(r'^(?P<pk>[0-9]+)/galaxy_credentials/$', OrganizationGalaxyCredentialsList.as_view(), name='organization_galaxy_credentials_list'),
     url(r'^(?P<pk>[0-9]+)/object_roles/$', OrganizationObjectRolesList.as_view(), name='organization_object_roles_list'),

awx/api/urls/project.py

@@ -35,10 +35,16 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/activity_stream/$', ProjectActivityStreamList.as_view(), name='project_activity_stream_list'),
     url(r'^(?P<pk>[0-9]+)/schedules/$', ProjectSchedulesList.as_view(), name='project_schedules_list'),
     url(r'^(?P<pk>[0-9]+)/notification_templates_error/$', ProjectNotificationTemplatesErrorList.as_view(), name='project_notification_templates_error_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_success/$', ProjectNotificationTemplatesSuccessList.as_view(),
-        name='project_notification_templates_success_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_started/$', ProjectNotificationTemplatesStartedList.as_view(),
-        name='project_notification_templates_started_list'),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_success/$',
+        ProjectNotificationTemplatesSuccessList.as_view(),
+        name='project_notification_templates_success_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_started/$',
+        ProjectNotificationTemplatesStartedList.as_view(),
+        name='project_notification_templates_started_list',
+    ),
     url(r'^(?P<pk>[0-9]+)/object_roles/$', ProjectObjectRolesList.as_view(), name='project_object_roles_list'),
     url(r'^(?P<pk>[0-9]+)/access_list/$', ProjectAccessList.as_view(), name='project_access_list'),
     url(r'^(?P<pk>[0-9]+)/copy/$', ProjectCopy.as_view(), name='project_copy'),

awx/api/urls/role.py

@@ -3,14 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    RoleList,
-    RoleDetail,
-    RoleUsersList,
-    RoleTeamsList,
-    RoleParentsList,
-    RoleChildrenList,
-)
+from awx.api.views import RoleList, RoleDetail, RoleUsersList, RoleTeamsList, RoleParentsList, RoleChildrenList
 
 
 urls = [

awx/api/urls/schedule.py

@@ -3,12 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    ScheduleList,
-    ScheduleDetail,
-    ScheduleUnifiedJobsList,
-    ScheduleCredentialsList,
-)
+from awx.api.views import ScheduleList, ScheduleDetail, ScheduleUnifiedJobsList, ScheduleCredentialsList
 
 
 urls = [

awx/api/urls/system_job.py

@@ -3,13 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    SystemJobList,
-    SystemJobDetail,
-    SystemJobCancel,
-    SystemJobNotificationsList,
-    SystemJobEventsList
-)
+from awx.api.views import SystemJobList, SystemJobDetail, SystemJobCancel, SystemJobNotificationsList, SystemJobEventsList
 
 
 urls = [

awx/api/urls/system_job_template.py

@@ -21,12 +21,21 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/launch/$', SystemJobTemplateLaunch.as_view(), name='system_job_template_launch'),
     url(r'^(?P<pk>[0-9]+)/jobs/$', SystemJobTemplateJobsList.as_view(), name='system_job_template_jobs_list'),
     url(r'^(?P<pk>[0-9]+)/schedules/$', SystemJobTemplateSchedulesList.as_view(), name='system_job_template_schedules_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_started/$', SystemJobTemplateNotificationTemplatesStartedList.as_view(),
-        name='system_job_template_notification_templates_started_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_error/$', SystemJobTemplateNotificationTemplatesErrorList.as_view(),
-        name='system_job_template_notification_templates_error_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_success/$', SystemJobTemplateNotificationTemplatesSuccessList.as_view(),
-        name='system_job_template_notification_templates_success_list'),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_started/$',
+        SystemJobTemplateNotificationTemplatesStartedList.as_view(),
+        name='system_job_template_notification_templates_started_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_error/$',
+        SystemJobTemplateNotificationTemplatesErrorList.as_view(),
+        name='system_job_template_notification_templates_error_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_success/$',
+        SystemJobTemplateNotificationTemplatesSuccessList.as_view(),
+        name='system_job_template_notification_templates_success_list',
+    ),
 ]
 
 __all__ = ['urls']

awx/api/urls/urls.py

@@ -5,10 +5,7 @@ from __future__ import absolute_import, unicode_literals
 from django.conf import settings
 from django.conf.urls import include, url
 
-from awx.api.generics import (
-    LoggedLoginView,
-    LoggedLogoutView,
-)
+from awx.api.generics import LoggedLoginView, LoggedLogoutView
 from awx.api.views import (
     ApiRootView,
     ApiV2RootView,
@@ -33,9 +30,7 @@ from awx.api.views import (
     OAuth2ApplicationDetail,
 )
 
-from awx.api.views.metrics import (
-    MetricsView,
-)
+from awx.api.views.metrics import MetricsView
 
 from .organization import urls as organization_urls
 from .user import urls as user_urls
@@ -48,7 +43,6 @@ from .host import urls as host_urls
 from .group import urls as group_urls
 from .inventory_source import urls as inventory_source_urls
 from .inventory_update import urls as inventory_update_urls
-from .inventory_script import urls as inventory_script_urls
 from .credential_type import urls as credential_type_urls
 from .credential import urls as credential_urls
 from .credential_input_source import urls as credential_input_source_urls
@@ -116,7 +110,6 @@ v2_urls = [
     url(r'^groups/', include(group_urls)),
     url(r'^inventory_sources/', include(inventory_source_urls)),
     url(r'^inventory_updates/', include(inventory_update_urls)),
-    url(r'^inventory_scripts/', include(inventory_script_urls)),
     url(r'^credentials/', include(credential_urls)),
     url(r'^roles/', include(role_urls)),
     url(r'^job_templates/', include(job_template_urls)),
@@ -146,17 +139,11 @@ app_name = 'api'
 urlpatterns = [
     url(r'^$', ApiRootView.as_view(), name='api_root_view'),
     url(r'^(?P<version>(v2))/', include(v2_urls)),
-    url(r'^login/$', LoggedLoginView.as_view(
-        template_name='rest_framework/login.html',
-        extra_context={'inside_login_context': True}
-    ), name='login'),
-    url(r'^logout/$', LoggedLogoutView.as_view(
-        next_page='/api/', redirect_field_name='next'
-    ), name='logout'),
+    url(r'^login/$', LoggedLoginView.as_view(template_name='rest_framework/login.html', extra_context={'inside_login_context': True}), name='login'),
+    url(r'^logout/$', LoggedLogoutView.as_view(next_page='/api/', redirect_field_name='next'), name='logout'),
     url(r'^o/', include(oauth2_root_urls)),
 ]
 if settings.SETTINGS_MODULE == 'awx.settings.development':
     from awx.api.swagger import SwaggerSchemaView
-    urlpatterns += [
-        url(r'^swagger/$', SwaggerSchemaView.as_view(), name='swagger_view'),
-    ]
+
+    urlpatterns += [url(r'^swagger/$', SwaggerSchemaView.as_view(), name='swagger_view')]

awx/api/urls/user.py

@@ -20,7 +20,7 @@ from awx.api.views import (
     UserAuthorizedTokenList,
 )
 
-urls = [ 
+urls = [
     url(r'^$', UserList.as_view(), name='user_list'),
     url(r'^(?P<pk>[0-9]+)/$', UserDetail.as_view(), name='user_detail'),
     url(r'^(?P<pk>[0-9]+)/teams/$', UserTeamsList.as_view(), name='user_teams_list'),
@@ -35,7 +35,6 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/tokens/$', OAuth2UserTokenList.as_view(), name='o_auth2_token_list'),
     url(r'^(?P<pk>[0-9]+)/authorized_tokens/$', UserAuthorizedTokenList.as_view(), name='user_authorized_token_list'),
     url(r'^(?P<pk>[0-9]+)/personal_tokens/$', UserPersonalTokenList.as_view(), name='user_personal_token_list'),
-    
-] 
+]
 
 __all__ = ['urls']

awx/api/urls/webhooks.py

@@ -1,10 +1,6 @@
 from django.conf.urls import url
 
-from awx.api.views import (
-    WebhookKeyView,
-    GithubWebhookReceiver,
-    GitlabWebhookReceiver,
-)
+from awx.api.views import WebhookKeyView, GithubWebhookReceiver, GitlabWebhookReceiver
 
 
 urlpatterns = [

awx/api/urls/workflow_approval.py

@@ -3,12 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    WorkflowApprovalList,
-    WorkflowApprovalDetail,
-    WorkflowApprovalApprove,
-    WorkflowApprovalDeny,
-)
+from awx.api.views import WorkflowApprovalList, WorkflowApprovalDetail, WorkflowApprovalApprove, WorkflowApprovalDeny
 
 
 urls = [

awx/api/urls/workflow_approval_template.py

@@ -3,10 +3,7 @@
 
 from django.conf.urls import url
 
-from awx.api.views import (
-    WorkflowApprovalTemplateDetail,
-    WorkflowApprovalTemplateJobsList,
-)
+from awx.api.views import WorkflowApprovalTemplateDetail, WorkflowApprovalTemplateJobsList
 
 
 urls = [

awx/api/urls/workflow_job_template.py

@@ -33,14 +33,26 @@ urls = [
     url(r'^(?P<pk>[0-9]+)/survey_spec/$', WorkflowJobTemplateSurveySpec.as_view(), name='workflow_job_template_survey_spec'),
     url(r'^(?P<pk>[0-9]+)/workflow_nodes/$', WorkflowJobTemplateWorkflowNodesList.as_view(), name='workflow_job_template_workflow_nodes_list'),
     url(r'^(?P<pk>[0-9]+)/activity_stream/$', WorkflowJobTemplateActivityStreamList.as_view(), name='workflow_job_template_activity_stream_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_started/$', WorkflowJobTemplateNotificationTemplatesStartedList.as_view(),
-        name='workflow_job_template_notification_templates_started_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_error/$', WorkflowJobTemplateNotificationTemplatesErrorList.as_view(),
-        name='workflow_job_template_notification_templates_error_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_success/$', WorkflowJobTemplateNotificationTemplatesSuccessList.as_view(),
-        name='workflow_job_template_notification_templates_success_list'),
-    url(r'^(?P<pk>[0-9]+)/notification_templates_approvals/$', WorkflowJobTemplateNotificationTemplatesApprovalList.as_view(),
-        name='workflow_job_template_notification_templates_approvals_list'),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_started/$',
+        WorkflowJobTemplateNotificationTemplatesStartedList.as_view(),
+        name='workflow_job_template_notification_templates_started_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_error/$',
+        WorkflowJobTemplateNotificationTemplatesErrorList.as_view(),
+        name='workflow_job_template_notification_templates_error_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_success/$',
+        WorkflowJobTemplateNotificationTemplatesSuccessList.as_view(),
+        name='workflow_job_template_notification_templates_success_list',
+    ),
+    url(
+        r'^(?P<pk>[0-9]+)/notification_templates_approvals/$',
+        WorkflowJobTemplateNotificationTemplatesApprovalList.as_view(),
+        name='workflow_job_template_notification_templates_approvals_list',
+    ),
     url(r'^(?P<pk>[0-9]+)/access_list/$', WorkflowJobTemplateAccessList.as_view(), name='workflow_job_template_access_list'),
     url(r'^(?P<pk>[0-9]+)/object_roles/$', WorkflowJobTemplateObjectRolesList.as_view(), name='workflow_job_template_object_roles_list'),
     url(r'^(?P<pk>[0-9]+)/labels/$', WorkflowJobTemplateLabelList.as_view(), name='workflow_job_template_label_list'),

awx/api/versioning.py

@@ -40,13 +40,10 @@ def reverse(viewname, args=None, kwargs=None, request=None, format=None, **extra
 
 
 class URLPathVersioning(BaseVersioning):
-
     def reverse(self, viewname, args=None, kwargs=None, request=None, format=None, **extra):
         if request.version is not None:
             kwargs = {} if (kwargs is None) else kwargs
             kwargs[self.version_param] = request.version
         request = None
 
-        return super(BaseVersioning, self).reverse(
-            viewname, args, kwargs, request, format, **extra
-        )
+        return super(BaseVersioning, self).reverse(viewname, args, kwargs, request, format, **extra)

awx/api/views/inventory.py

@@ -25,17 +25,8 @@ from awx.main.models import (
     InstanceGroup,
     InventoryUpdateEvent,
     InventoryUpdate,
-    InventorySource,
-    CustomInventoryScript,
-)
-from awx.api.generics import (
-    ListCreateAPIView,
-    RetrieveUpdateDestroyAPIView,
-    SubListAPIView,
-    SubListAttachDetachAPIView,
-    ResourceAccessList,
-    CopyAPIView,
 )
+from awx.api.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView, SubListAPIView, SubListAttachDetachAPIView, ResourceAccessList, CopyAPIView
 
 from awx.api.serializers import (
     InventorySerializer,
@@ -43,13 +34,9 @@ from awx.api.serializers import (
     RoleSerializer,
     InstanceGroupSerializer,
     InventoryUpdateEventSerializer,
-    CustomInventoryScriptSerializer,
     JobTemplateSerializer,
 )
-from awx.api.views.mixin import (
-    RelatedJobsPreventDeleteMixin,
-    ControlledByScmMixin,
-)
+from awx.api.views.mixin import RelatedJobsPreventDeleteMixin, ControlledByScmMixin
 
 logger = logging.getLogger('awx.api.views.organization')
 
@@ -68,55 +55,6 @@ class InventoryUpdateEventsList(SubListAPIView):
         return super(InventoryUpdateEventsList, self).finalize_response(request, response, *args, **kwargs)
 
 
-class InventoryScriptList(ListCreateAPIView):
-
-    deprecated = True
-
-    model = CustomInventoryScript
-    serializer_class = CustomInventoryScriptSerializer
-
-
-class InventoryScriptDetail(RetrieveUpdateDestroyAPIView):
-
-    deprecated = True
-
-    model = CustomInventoryScript
-    serializer_class = CustomInventoryScriptSerializer
-
-    def destroy(self, request, *args, **kwargs):
-        instance = self.get_object()
-        can_delete = request.user.can_access(self.model, 'delete', instance)
-        if not can_delete:
-            raise PermissionDenied(_("Cannot delete inventory script."))
-        for inv_src in InventorySource.objects.filter(source_script=instance):
-            inv_src.source_script = None
-            inv_src.save()
-        return super(InventoryScriptDetail, self).destroy(request, *args, **kwargs)
-
-
-class InventoryScriptObjectRolesList(SubListAPIView):
-
-    deprecated = True
-
-    model = Role
-    serializer_class = RoleSerializer
-    parent_model = CustomInventoryScript
-    search_fields = ('role_field', 'content_type__model',)
-
-    def get_queryset(self):
-        po = self.get_parent_object()
-        content_type = ContentType.objects.get_for_model(self.parent_model)
-        return Role.objects.filter(content_type=content_type, object_id=po.pk)
-
-
-class InventoryScriptCopy(CopyAPIView):
-
-    deprecated = True
-
-    model = CustomInventoryScript
-    copy_return_serializer_class = CustomInventoryScriptSerializer
-
-
 class InventoryList(ListCreateAPIView):
 
     model = Inventory
@@ -134,8 +72,7 @@ class InventoryDetail(RelatedJobsPreventDeleteMixin, ControlledByScmMixin, Retri
 
         # Do not allow changes to an Inventory kind.
         if kind is not None and obj.kind != kind:
-            return Response(dict(error=_('You cannot turn a regular inventory into a "smart" inventory.')),
-                            status=status.HTTP_405_METHOD_NOT_ALLOWED)
+            return Response(dict(error=_('You cannot turn a regular inventory into a "smart" inventory.')), status=status.HTTP_405_METHOD_NOT_ALLOWED)
         return super(InventoryDetail, self).update(request, *args, **kwargs)
 
     def destroy(self, request, *args, **kwargs):
@@ -175,7 +112,7 @@ class InventoryInstanceGroupsList(SubListAttachDetachAPIView):
 
 class InventoryAccessList(ResourceAccessList):
 
-    model = User # needs to be User for AccessLists's
+    model = User  # needs to be User for AccessLists's
     parent_model = Inventory
 
 
@@ -184,7 +121,7 @@ class InventoryObjectRolesList(SubListAPIView):
     model = Role
     serializer_class = RoleSerializer
     parent_model = Inventory
-    search_fields = ('role_field', 'content_type__model',)
+    search_fields = ('role_field', 'content_type__model')
 
     def get_queryset(self):
         po = self.get_parent_object()

awx/api/views/metrics.py

@@ -14,12 +14,11 @@ from rest_framework.exceptions import PermissionDenied
 
 # AWX
 # from awx.main.analytics import collectors
+import awx.main.analytics.subsystem_metrics as s_metrics
 from awx.main.analytics.metrics import metrics
 from awx.api import renderers
 
-from awx.api.generics import (
-    APIView,
-)
+from awx.api.generics import APIView
 
 
 logger = logging.getLogger('awx.analytics')
@@ -30,13 +29,15 @@ class MetricsView(APIView):
     name = _('Metrics')
     swagger_topic = 'Metrics'
 
-    renderer_classes = [renderers.PlainTextRenderer,
-                        renderers.PrometheusJSONRenderer,
-                        renderers.BrowsableAPIRenderer,]
+    renderer_classes = [renderers.PlainTextRenderer, renderers.PrometheusJSONRenderer, renderers.BrowsableAPIRenderer]
 
     def get(self, request):
-        ''' Show Metrics Details '''
-        if (request.user.is_superuser or request.user.is_system_auditor):
-            return Response(metrics().decode('UTF-8'))
+        '''Show Metrics Details'''
+        if request.user.is_superuser or request.user.is_system_auditor:
+            metrics_to_show = ''
+            if not request.query_params.get('subsystemonly', "0") == "1":
+                metrics_to_show += metrics().decode('UTF-8')
+            if not request.query_params.get('dbonly', "0") == "1":
+                metrics_to_show += s_metrics.metrics(request)
+            return Response(metrics_to_show)
         raise PermissionDenied()
-

awx/api/views/mixin.py

@@ -16,14 +16,8 @@ from rest_framework.response import Response
 from rest_framework import status
 
 from awx.main.constants import ACTIVE_STATES
-from awx.main.utils import (
-    get_object_or_400,
-    parse_yaml_or_json,
-)
-from awx.main.models.ha import (
-    Instance,
-    InstanceGroup,
-)
+from awx.main.utils import get_object_or_400, parse_yaml_or_json
+from awx.main.models.ha import Instance, InstanceGroup
 from awx.main.models.organization import Team
 from awx.main.models.projects import Project
 from awx.main.models.inventory import Inventory
@@ -34,9 +28,10 @@ logger = logging.getLogger('awx.api.views.mixin')
 
 
 class UnifiedJobDeletionMixin(object):
-    '''
+    """
     Special handling when deleting a running unified job object.
-    '''
+    """
+
     def destroy(self, request, *args, **kwargs):
         obj = self.get_object()
         if not request.user.can_access(self.model, 'delete', obj):
@@ -53,22 +48,21 @@ class UnifiedJobDeletionMixin(object):
             # Prohibit deletion if job events are still coming in
             if obj.finished and now() < obj.finished + dateutil.relativedelta.relativedelta(minutes=1):
                 # less than 1 minute has passed since job finished and events are not in
-                return Response({"error": _("Job has not finished processing events.")},
-                                status=status.HTTP_400_BAD_REQUEST)
+                return Response({"error": _("Job has not finished processing events.")}, status=status.HTTP_400_BAD_REQUEST)
             else:
                 # if it has been > 1 minute, events are probably lost
-                logger.warning('Allowing deletion of {} through the API without all events '
-                               'processed.'.format(obj.log_format))
+                logger.warning('Allowing deletion of {} through the API without all events ' 'processed.'.format(obj.log_format))
         obj.delete()
         return Response(status=status.HTTP_204_NO_CONTENT)
 
 
 class InstanceGroupMembershipMixin(object):
-    '''
+    """
     This mixin overloads attach/detach so that it calls InstanceGroup.save(),
     triggering a background recalculation of policy-based instance group
     membership.
-    '''
+    """
+
     def attach(self, request, *args, **kwargs):
         response = super(InstanceGroupMembershipMixin, self).attach(request, *args, **kwargs)
         sub_id, res = self.attach_validate(request)
@@ -84,24 +78,13 @@ class InstanceGroupMembershipMixin(object):
                     ig_obj = get_object_or_400(ig_qs, pk=sub_id)
                 else:
                     # similar to get_parent_object, but selected for update
-                    parent_filter = {
-                        self.lookup_field: self.kwargs.get(self.lookup_field, None),
-                    }
+                    parent_filter = {self.lookup_field: self.kwargs.get(self.lookup_field, None)}
                     ig_obj = get_object_or_404(ig_qs, **parent_filter)
                 if inst_name not in ig_obj.policy_instance_list:
                     ig_obj.policy_instance_list.append(inst_name)
                     ig_obj.save(update_fields=['policy_instance_list'])
         return response
 
-    def is_valid_relation(self, parent, sub, created=False):
-        if sub.is_isolated():
-            return {'error': _('Isolated instances may not be added or removed from instances groups via the API.')}
-        if self.parent_model is InstanceGroup:
-            ig_obj = self.get_parent_object()
-            if ig_obj.controller_id is not None:
-                return {'error': _('Isolated instance group membership may not be managed via the API.')}
-        return None
-
     def unattach_validate(self, request):
         (sub_id, res) = super(InstanceGroupMembershipMixin, self).unattach_validate(request)
         if res:
@@ -126,9 +109,7 @@ class InstanceGroupMembershipMixin(object):
                     ig_obj = get_object_or_400(ig_qs, pk=sub_id)
                 else:
                     # similar to get_parent_object, but selected for update
-                    parent_filter = {
-                        self.lookup_field: self.kwargs.get(self.lookup_field, None),
-                    }
+                    parent_filter = {self.lookup_field: self.kwargs.get(self.lookup_field, None)}
                     ig_obj = get_object_or_404(ig_qs, **parent_filter)
                 if inst_name in ig_obj.policy_instance_list:
                     ig_obj.policy_instance_list.pop(ig_obj.policy_instance_list.index(inst_name))
@@ -146,16 +127,13 @@ class RelatedJobsPreventDeleteMixin(object):
         if len(active_jobs) > 0:
             raise ActiveJobConflict(active_jobs)
         time_cutoff = now() - dateutil.relativedelta.relativedelta(minutes=1)
-        recent_jobs = obj._get_related_jobs().filter(finished__gte = time_cutoff)
+        recent_jobs = obj._get_related_jobs().filter(finished__gte=time_cutoff)
         for unified_job in recent_jobs.get_real_instances():
             if not unified_job.event_processing_finished:
-                raise PermissionDenied(_(
-                    'Related job {} is still processing events.'
-                ).format(unified_job.log_format))
+                raise PermissionDenied(_('Related job {} is still processing events.').format(unified_job.log_format))
 
 
 class OrganizationCountsMixin(object):
-
     def get_serializer_context(self, *args, **kwargs):
         full_context = super(OrganizationCountsMixin, self).get_serializer_context(*args, **kwargs)
 
@@ -177,26 +155,23 @@ class OrganizationCountsMixin(object):
         # Produce counts of Foreign Key relationships
         db_results['inventories'] = inv_qs.values('organization').annotate(Count('organization')).order_by('organization')
 
-        db_results['teams'] = Team.accessible_objects(
-            self.request.user, 'read_role').values('organization').annotate(
-            Count('organization')).order_by('organization')
+        db_results['teams'] = (
+            Team.accessible_objects(self.request.user, 'read_role').values('organization').annotate(Count('organization')).order_by('organization')
+        )
 
         db_results['job_templates'] = jt_qs.values('organization').annotate(Count('organization')).order_by('organization')
 
         db_results['projects'] = project_qs.values('organization').annotate(Count('organization')).order_by('organization')
 
         # Other members and admins of organization are always viewable
-        db_results['users'] = org_qs.annotate(
-            users=Count('member_role__members', distinct=True),
-            admins=Count('admin_role__members', distinct=True)
-        ).values('id', 'users', 'admins')
+        db_results['users'] = org_qs.annotate(users=Count('member_role__members', distinct=True), admins=Count('admin_role__members', distinct=True)).values(
+            'id', 'users', 'admins'
+        )
 
         count_context = {}
         for org in org_id_list:
             org_id = org['id']
-            count_context[org_id] = {
-                'inventories': 0, 'teams': 0, 'users': 0, 'job_templates': 0,
-                'admins': 0, 'projects': 0}
+            count_context[org_id] = {'inventories': 0, 'teams': 0, 'users': 0, 'job_templates': 0, 'admins': 0, 'projects': 0}
 
         for res, count_qs in db_results.items():
             if res == 'users':
@@ -218,21 +193,20 @@ class OrganizationCountsMixin(object):
 
 
 class ControlledByScmMixin(object):
-    '''
+    """
     Special method to reset SCM inventory commit hash
     if anything that it manages changes.
-    '''
+    """
 
     def _reset_inv_src_rev(self, obj):
         if self.request.method in SAFE_METHODS or not obj:
             return
-        project_following_sources = obj.inventory_sources.filter(
-            update_on_project_update=True, source='scm')
+        project_following_sources = obj.inventory_sources.filter(update_on_project_update=True, source='scm')
         if project_following_sources:
             # Allow inventory changes unrelated to variables
             if self.model == Inventory and (
-                    not self.request or not self.request.data or
-                    parse_yaml_or_json(self.request.data.get('variables', '')) == parse_yaml_or_json(obj.variables)):
+                not self.request or not self.request.data or parse_yaml_or_json(self.request.data.get('variables', '')) == parse_yaml_or_json(obj.variables)
+            ):
                 return
             project_following_sources.update(scm_last_revision='')
 

awx/api/views/organization.py

@@ -24,7 +24,7 @@ from awx.main.models import (
     User,
     Team,
     InstanceGroup,
-    Credential
+    Credential,
 )
 from awx.api.generics import (
     ListCreateAPIView,
@@ -47,13 +47,12 @@ from awx.api.serializers import (
     NotificationTemplateSerializer,
     InstanceGroupSerializer,
     ExecutionEnvironmentSerializer,
-    ProjectSerializer, JobTemplateSerializer, WorkflowJobTemplateSerializer,
-    CredentialSerializer
-)
-from awx.api.views.mixin import (
-    RelatedJobsPreventDeleteMixin,
-    OrganizationCountsMixin,
+    ProjectSerializer,
+    JobTemplateSerializer,
+    WorkflowJobTemplateSerializer,
+    CredentialSerializer,
 )
+from awx.api.views.mixin import RelatedJobsPreventDeleteMixin, OrganizationCountsMixin
 
 logger = logging.getLogger('awx.api.views.organization')
 
@@ -84,23 +83,20 @@ class OrganizationDetail(RelatedJobsPreventDeleteMixin, RetrieveUpdateDestroyAPI
 
         org_counts = {}
         access_kwargs = {'accessor': self.request.user, 'role_field': 'read_role'}
-        direct_counts = Organization.objects.filter(id=org_id).annotate(
-            users=Count('member_role__members', distinct=True),
-            admins=Count('admin_role__members', distinct=True)
-        ).values('users', 'admins')
+        direct_counts = (
+            Organization.objects.filter(id=org_id)
+            .annotate(users=Count('member_role__members', distinct=True), admins=Count('admin_role__members', distinct=True))
+            .values('users', 'admins')
+        )
 
         if not direct_counts:
             return full_context
 
         org_counts = direct_counts[0]
-        org_counts['inventories'] = Inventory.accessible_objects(**access_kwargs).filter(
-            organization__id=org_id).count()
-        org_counts['teams'] = Team.accessible_objects(**access_kwargs).filter(
-            organization__id=org_id).count()
-        org_counts['projects'] = Project.accessible_objects(**access_kwargs).filter(
-            organization__id=org_id).count()
-        org_counts['job_templates'] = JobTemplate.accessible_objects(**access_kwargs).filter(
-            organization__id=org_id).count()
+        org_counts['inventories'] = Inventory.accessible_objects(**access_kwargs).filter(organization__id=org_id).count()
+        org_counts['teams'] = Team.accessible_objects(**access_kwargs).filter(organization__id=org_id).count()
+        org_counts['projects'] = Project.accessible_objects(**access_kwargs).filter(organization__id=org_id).count()
+        org_counts['job_templates'] = JobTemplate.accessible_objects(**access_kwargs).filter(organization__id=org_id).count()
         org_counts['hosts'] = Host.objects.org_active_count(org_id)
 
         full_context['related_field_counts'] = {}
@@ -240,14 +236,12 @@ class OrganizationGalaxyCredentialsList(SubListAttachDetachAPIView):
 
     def is_valid_relation(self, parent, sub, created=False):
         if sub.kind != 'galaxy_api_token':
-            return {'msg': _(
-                f"Credential must be a Galaxy credential, not {sub.credential_type.name}."
-            )}
+            return {'msg': _(f"Credential must be a Galaxy credential, not {sub.credential_type.name}.")}
 
 
 class OrganizationAccessList(ResourceAccessList):
 
-    model = User # needs to be User for AccessLists's
+    model = User  # needs to be User for AccessLists's
     parent_model = Organization
 
 
@@ -256,7 +250,7 @@ class OrganizationObjectRolesList(SubListAPIView):
     model = Role
     serializer_class = RoleSerializer
     parent_model = Organization
-    search_fields = ('role_field', 'content_type__model',)
+    search_fields = ('role_field', 'content_type__model')
 
     def get_queryset(self):
         po = self.get_parent_object()

awx/api/views/root.py

@@ -24,22 +24,11 @@ from awx.api.generics import APIView
 from awx.conf.registry import settings_registry
 from awx.main.analytics import all_collectors
 from awx.main.ha import is_ha_environment
-from awx.main.utils import (
-    get_awx_version,
-    get_ansible_version,
-    get_custom_venv_choices,
-    to_python_boolean,
-)
+from awx.main.utils import get_awx_version, get_custom_venv_choices, to_python_boolean
 from awx.main.utils.licensing import validate_entitlement_manifest
 from awx.api.versioning import reverse, drf_reverse
 from awx.main.constants import PRIVILEGE_ESCALATION_METHODS
-from awx.main.models import (
-    Project,
-    Organization,
-    Instance,
-    InstanceGroup,
-    JobTemplate,
-)
+from awx.main.models import Project, Organization, Instance, InstanceGroup, JobTemplate
 from awx.main.utils import set_environ
 
 logger = logging.getLogger('awx.api.views.root')
@@ -54,13 +43,13 @@ class ApiRootView(APIView):
 
     @method_decorator(ensure_csrf_cookie)
     def get(self, request, format=None):
-        ''' List supported API versions '''
+        '''List supported API versions'''
 
         v2 = reverse('api:api_v2_root_view', kwargs={'version': 'v2'})
         data = OrderedDict()
         data['description'] = _('AWX REST API')
         data['current_version'] = v2
-        data['available_versions'] = dict(v2 = v2)
+        data['available_versions'] = dict(v2=v2)
         data['oauth2'] = drf_reverse('api:oauth_authorization_root_view')
         data['custom_logo'] = settings.CUSTOM_LOGO
         data['custom_login_info'] = settings.CUSTOM_LOGIN_INFO
@@ -89,7 +78,7 @@ class ApiVersionRootView(APIView):
     swagger_topic = 'Versioning'
 
     def get(self, request, format=None):
-        ''' List top level resources '''
+        '''List top level resources'''
         data = OrderedDict()
         data['ping'] = reverse('api:api_v2_ping_view', request=request)
         data['instances'] = reverse('api:instance_list', request=request)
@@ -111,7 +100,6 @@ class ApiVersionRootView(APIView):
         data['tokens'] = reverse('api:o_auth2_token_list', request=request)
         data['metrics'] = reverse('api:metrics_view', request=request)
         data['inventory'] = reverse('api:inventory_list', request=request)
-        data['inventory_scripts'] = reverse('api:inventory_script_list', request=request)
         data['inventory_sources'] = reverse('api:inventory_source_list', request=request)
         data['inventory_updates'] = reverse('api:inventory_update_list', request=request)
         data['groups'] = reverse('api:group_list', request=request)
@@ -146,6 +134,7 @@ class ApiV2PingView(APIView):
     """A simple view that reports very basic information about this
     instance, which is acceptable to be public information.
     """
+
     permission_classes = (AllowAny,)
     authentication_classes = ()
     name = _('Ping')
@@ -157,23 +146,19 @@ class ApiV2PingView(APIView):
         Everything returned here should be considered public / insecure, as
         this requires no auth and is intended for use by the installer process.
         """
-        response = {
-            'ha': is_ha_environment(),
-            'version': get_awx_version(),
-            'active_node': settings.CLUSTER_HOST_ID,
-            'install_uuid': settings.INSTALL_UUID,
-        }
+        response = {'ha': is_ha_environment(), 'version': get_awx_version(), 'active_node': settings.CLUSTER_HOST_ID, 'install_uuid': settings.INSTALL_UUID}
 
         response['instances'] = []
         for instance in Instance.objects.all():
-            response['instances'].append(dict(node=instance.hostname, uuid=instance.uuid, heartbeat=instance.modified,
-                                              capacity=instance.capacity, version=instance.version))
+            response['instances'].append(
+                dict(node=instance.hostname, uuid=instance.uuid, heartbeat=instance.modified, capacity=instance.capacity, version=instance.version)
+            )
             sorted(response['instances'], key=operator.itemgetter('node'))
         response['instance_groups'] = []
         for instance_group in InstanceGroup.objects.prefetch_related('instances'):
-            response['instance_groups'].append(dict(name=instance_group.name,
-                                                    capacity=instance_group.capacity,
-                                                    instances=[x.hostname for x in instance_group.instances.all()]))
+            response['instance_groups'].append(
+                dict(name=instance_group.name, capacity=instance_group.capacity, instances=[x.hostname for x in instance_group.instances.all()])
+            )
         return Response(response)
 
 
@@ -190,6 +175,7 @@ class ApiV2SubscriptionView(APIView):
 
     def post(self, request):
         from awx.main.utils.common import get_licenser
+
         data = request.data.copy()
         if data.get('subscriptions_password') == '$encrypted$':
             data['subscriptions_password'] = settings.SUBSCRIPTIONS_PASSWORD
@@ -203,10 +189,7 @@ class ApiV2SubscriptionView(APIView):
                 settings.SUBSCRIPTIONS_PASSWORD = data['subscriptions_password']
         except Exception as exc:
             msg = _("Invalid Subscription")
-            if (
-                isinstance(exc, requests.exceptions.HTTPError) and
-                getattr(getattr(exc, 'response', None), 'status_code', None) == 401
-            ):
+            if isinstance(exc, requests.exceptions.HTTPError) and getattr(getattr(exc, 'response', None), 'status_code', None) == 401:
                 msg = _("The provided credentials are invalid (HTTP 401).")
             elif isinstance(exc, requests.exceptions.ProxyError):
                 msg = _("Unable to connect to proxy server.")
@@ -215,8 +198,7 @@ class ApiV2SubscriptionView(APIView):
             elif isinstance(exc, (ValueError, OSError)) and exc.args:
                 msg = exc.args[0]
             else:
-                logger.exception(smart_text(u"Invalid subscription submitted."),
-                                 extra=dict(actor=request.user.username))
+                logger.exception(smart_text(u"Invalid subscription submitted."), extra=dict(actor=request.user.username))
             return Response({"error": msg}, status=status.HTTP_400_BAD_REQUEST)
 
         return Response(validated)
@@ -242,16 +224,14 @@ class ApiV2AttachView(APIView):
         pw = getattr(settings, 'SUBSCRIPTIONS_PASSWORD', None)
         if pool_id and user and pw:
             from awx.main.utils.common import get_licenser
+
             data = request.data.copy()
             try:
                 with set_environ(**settings.AWX_TASK_ENV):
                     validated = get_licenser().validate_rh(user, pw)
             except Exception as exc:
                 msg = _("Invalid Subscription")
-                if (
-                    isinstance(exc, requests.exceptions.HTTPError) and
-                    getattr(getattr(exc, 'response', None), 'status_code', None) == 401
-                ):
+                if isinstance(exc, requests.exceptions.HTTPError) and getattr(getattr(exc, 'response', None), 'status_code', None) == 401:
                     msg = _("The provided credentials are invalid (HTTP 401).")
                 elif isinstance(exc, requests.exceptions.ProxyError):
                     msg = _("Unable to connect to proxy server.")
@@ -260,8 +240,7 @@ class ApiV2AttachView(APIView):
                 elif isinstance(exc, (ValueError, OSError)) and exc.args:
                     msg = exc.args[0]
                 else:
-                    logger.exception(smart_text(u"Invalid subscription submitted."),
-                                     extra=dict(actor=request.user.username))
+                    logger.exception(smart_text(u"Invalid subscription submitted."), extra=dict(actor=request.user.username))
                 return Response({"error": msg}, status=status.HTTP_400_BAD_REQUEST)
         for sub in validated:
             if sub['pool_id'] == pool_id:
@@ -287,6 +266,7 @@ class ApiV2ConfigView(APIView):
         '''Return various sitewide configuration settings'''
 
         from awx.main.utils.common import get_licenser
+
         license_data = get_licenser().validate()
 
         if not license_data.get('valid_key', False):
@@ -298,7 +278,6 @@ class ApiV2ConfigView(APIView):
             time_zone=settings.TIME_ZONE,
             license_info=license_data,
             version=get_awx_version(),
-            ansible_version=get_ansible_version(),
             eula=render_to_string("eula.md") if license_data.get('license_type', 'UNLICENSED') != 'open' else '',
             analytics_status=pendo_state,
             analytics_collectors=all_collectors(),
@@ -314,22 +293,23 @@ class ApiV2ConfigView(APIView):
             user_ldap_fields.extend(getattr(settings, 'AUTH_LDAP_USER_FLAGS_BY_GROUP', {}).keys())
             data['user_ldap_fields'] = user_ldap_fields
 
-        if request.user.is_superuser \
-                or request.user.is_system_auditor \
-                or Organization.accessible_objects(request.user, 'admin_role').exists() \
-                or Organization.accessible_objects(request.user, 'auditor_role').exists() \
-                or Organization.accessible_objects(request.user, 'project_admin_role').exists():
-            data.update(dict(
-                project_base_dir = settings.PROJECTS_ROOT,
-                project_local_paths = Project.get_local_path_choices(),
-                custom_virtualenvs = get_custom_venv_choices()
-            ))
+        if (
+            request.user.is_superuser
+            or request.user.is_system_auditor
+            or Organization.accessible_objects(request.user, 'admin_role').exists()
+            or Organization.accessible_objects(request.user, 'auditor_role').exists()
+            or Organization.accessible_objects(request.user, 'project_admin_role').exists()
+        ):
+            data.update(
+                dict(
+                    project_base_dir=settings.PROJECTS_ROOT, project_local_paths=Project.get_local_path_choices(), custom_virtualenvs=get_custom_venv_choices()
+                )
+            )
         elif JobTemplate.accessible_objects(request.user, 'admin_role').exists():
             data['custom_virtualenvs'] = get_custom_venv_choices()
 
         return Response(data)
 
-
     def post(self, request):
         if not isinstance(request.data, dict):
             return Response({"error": _("Invalid subscription data")}, status=status.HTTP_400_BAD_REQUEST)
@@ -346,11 +326,11 @@ class ApiV2ConfigView(APIView):
         try:
             data_actual = json.dumps(request.data)
         except Exception:
-            logger.info(smart_text(u"Invalid JSON submitted for license."),
-                        extra=dict(actor=request.user.username))
+            logger.info(smart_text(u"Invalid JSON submitted for license."), extra=dict(actor=request.user.username))
             return Response({"error": _("Invalid JSON")}, status=status.HTTP_400_BAD_REQUEST)
 
         from awx.main.utils.common import get_licenser
+
         license_data = json.loads(data_actual)
         if 'license_key' in license_data:
             return Response({"error": _('Legacy license submitted. A subscription manifest is now required.')}, status=status.HTTP_400_BAD_REQUEST)
@@ -358,10 +338,7 @@ class ApiV2ConfigView(APIView):
             try:
                 json_actual = json.loads(base64.b64decode(license_data['manifest']))
                 if 'license_key' in json_actual:
-                    return Response(
-                        {"error": _('Legacy license submitted. A subscription manifest is now required.')},
-                        status=status.HTTP_400_BAD_REQUEST
-                    )
+                    return Response({"error": _('Legacy license submitted. A subscription manifest is now required.')}, status=status.HTTP_400_BAD_REQUEST)
             except Exception:
                 pass
             try:
@@ -375,8 +352,7 @@ class ApiV2ConfigView(APIView):
             try:
                 license_data_validated = get_licenser().license_from_manifest(license_data)
             except Exception:
-                logger.warning(smart_text(u"Invalid subscription submitted."),
-                               extra=dict(actor=request.user.username))
+                logger.warning(smart_text(u"Invalid subscription submitted."), extra=dict(actor=request.user.username))
                 return Response({"error": _("Invalid License")}, status=status.HTTP_400_BAD_REQUEST)
         else:
             license_data_validated = get_licenser().validate()
@@ -387,8 +363,7 @@ class ApiV2ConfigView(APIView):
                 settings.TOWER_URL_BASE = "{}://{}".format(request.scheme, request.get_host())
             return Response(license_data_validated)
 
-        logger.warning(smart_text(u"Invalid subscription submitted."),
-                       extra=dict(actor=request.user.username))
+        logger.warning(smart_text(u"Invalid subscription submitted."), extra=dict(actor=request.user.username))
         return Response({"error": _("Invalid subscription")}, status=status.HTTP_400_BAD_REQUEST)
 
     def delete(self, request):

awx/api/views/webhooks.py

@@ -26,10 +26,7 @@ class WebhookKeyView(GenericAPIView):
     permission_classes = (WebhookKeyPermission,)
 
     def get_queryset(self):
-        qs_models = {
-            'job_templates': JobTemplate,
-            'workflow_job_templates': WorkflowJobTemplate,
-        }
+        qs_models = {'job_templates': JobTemplate, 'workflow_job_templates': WorkflowJobTemplate}
         self.model = qs_models.get(self.kwargs['model_kwarg'])
 
         return super().get_queryset()
@@ -57,10 +54,7 @@ class WebhookReceiverBase(APIView):
     ref_keys = {}
 
     def get_queryset(self):
-        qs_models = {
-            'job_templates': JobTemplate,
-            'workflow_job_templates': WorkflowJobTemplate,
-        }
+        qs_models = {'job_templates': JobTemplate, 'workflow_job_templates': WorkflowJobTemplate}
         model = qs_models.get(self.kwargs['model_kwarg'])
         if model is None:
             raise PermissionDenied
@@ -120,10 +114,7 @@ class WebhookReceiverBase(APIView):
         # Ensure that the full contents of the request are captured for multiple uses.
         request.body
 
-        logger.debug(
-            "headers: {}\n"
-            "data: {}\n".format(request.headers, request.data)
-        )
+        logger.debug("headers: {}\n" "data: {}\n".format(request.headers, request.data))
         obj = self.get_object()
         self.check_signature(obj)
 
@@ -132,16 +123,11 @@ class WebhookReceiverBase(APIView):
         event_ref = self.get_event_ref()
         status_api = self.get_event_status_api()
 
-        kwargs = {
-            'unified_job_template_id': obj.id,
-            'webhook_service': obj.webhook_service,
-            'webhook_guid': event_guid,
-        }
+        kwargs = {'unified_job_template_id': obj.id, 'webhook_service': obj.webhook_service, 'webhook_guid': event_guid}
         if WorkflowJob.objects.filter(**kwargs).exists() or Job.objects.filter(**kwargs).exists():
             # Short circuit if this webhook has already been received and acted upon.
             logger.debug("Webhook previously received, returning without action.")
-            return Response({'message': _("Webhook previously received, aborting.")},
-                            status=status.HTTP_202_ACCEPTED)
+            return Response({'message': _("Webhook previously received, aborting.")}, status=status.HTTP_202_ACCEPTED)
 
         kwargs = {
             '_eager_fields': {
@@ -156,7 +142,7 @@ class WebhookReceiverBase(APIView):
                 'tower_webhook_event_ref': event_ref,
                 'tower_webhook_status_api': status_api,
                 'tower_webhook_payload': request.data,
-            }
+            },
         }
 
         new_job = obj.create_unified_job(**kwargs)
@@ -205,11 +191,7 @@ class GithubWebhookReceiver(WebhookReceiverBase):
 class GitlabWebhookReceiver(WebhookReceiverBase):
     service = 'gitlab'
 
-    ref_keys = {
-        'Push Hook': 'checkout_sha',
-        'Tag Push Hook': 'checkout_sha',
-        'Merge Request Hook': 'object_attributes.last_commit.id',
-    }
+    ref_keys = {'Push Hook': 'checkout_sha', 'Tag Push Hook': 'checkout_sha', 'Merge Request Hook': 'object_attributes.last_commit.id'}
 
     def get_event_type(self):
         return self.request.META.get('HTTP_X_GITLAB_EVENT')
@@ -229,8 +211,7 @@ class GitlabWebhookReceiver(WebhookReceiverBase):
             return
         parsed = urllib.parse.urlparse(repo_url)
 
-        return "{}://{}/api/v4/projects/{}/statuses/{}".format(
-            parsed.scheme, parsed.netloc, project['id'], self.get_event_ref())
+        return "{}://{}/api/v4/projects/{}/statuses/{}".format(parsed.scheme, parsed.netloc, project['id'], self.get_event_ref())
 
     def get_signature(self):
         return force_bytes(self.request.META.get('HTTP_X_GITLAB_TOKEN') or '')

awx/asgi.py

@@ -4,11 +4,12 @@ import os
 import logging
 import django
 from awx import __version__ as tower_version
+
 # Prepare the AWX environment.
 from awx import prepare_env, MODE
 from channels.routing import get_default_application  # noqa
-prepare_env() # NOQA
 
+prepare_env()  # NOQA
 
 
 """
@@ -29,8 +30,8 @@ if MODE == 'production':
     except FileNotFoundError:
         pass
     except ValueError as e:
-        logger.error("Missing or incorrect metadata for Tower version.  Ensure Tower was installed using the setup playbook.")
-        raise Exception("Missing or incorrect metadata for Tower version.  Ensure Tower was installed using the setup playbook.") from e
+        logger.error("Missing or incorrect metadata for controller version.  Ensure controller was installed using the setup playbook.")
+        raise Exception("Missing or incorrect metadata for controller version.  Ensure controller was installed using the setup playbook.") from e
 
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "awx.settings")

awx/conf/__init__.py

@@ -4,7 +4,7 @@
 # Django
 from django.utils.module_loading import autodiscover_modules
 
-# Tower
+# AWX
 from .registry import settings_registry
 
 default_app_config = 'awx.conf.apps.ConfConfig'

awx/conf/access.py

@@ -4,18 +4,18 @@
 # Django
 from django.db.models import Q
 
-# Tower
+# AWX
 from awx.main.access import BaseAccess, register_access
 from awx.conf.models import Setting
 
 
 class SettingAccess(BaseAccess):
-    '''
+    """
     - I can see settings when I am a super user or system auditor.
     - I can edit settings when I am a super user.
     - I can clear settings when I am a super user.
     - I can always see/edit/clear my own user settings.
-    '''
+    """
 
     model = Setting
 

awx/conf/apps.py

@@ -1,5 +1,6 @@
 # Django
 from django.apps import AppConfig
+
 # from django.core import checks
 from django.utils.translation import ugettext_lazy as _
 
@@ -12,4 +13,5 @@ class ConfConfig(AppConfig):
     def ready(self):
         self.module.autodiscover()
         from .settings import SettingsWrapper
+
         SettingsWrapper.initialize()

awx/conf/conf.py

@@ -2,7 +2,7 @@
 from django.conf import settings
 from django.utils.translation import ugettext_lazy as _
 
-# Tower
+# AWX
 from awx.conf import fields, register
 from awx.conf import settings_registry
 

awx/conf/fields.py

@@ -10,10 +10,7 @@ from django.core.validators import URLValidator, _lazy_re_compile
 from django.utils.translation import ugettext_lazy as _
 
 # Django REST Framework
-from rest_framework.fields import (  # noqa
-    BooleanField, CharField, ChoiceField, DictField, DateTimeField, EmailField,
-    IntegerField, ListField, NullBooleanField
-)
+from rest_framework.fields import BooleanField, CharField, ChoiceField, DictField, DateTimeField, EmailField, IntegerField, ListField, NullBooleanField  # noqa
 from rest_framework.serializers import PrimaryKeyRelatedField  # noqa
 
 logger = logging.getLogger('awx.conf.fields')
@@ -27,7 +24,6 @@ logger = logging.getLogger('awx.conf.fields')
 
 
 class CharField(CharField):
-
     def to_representation(self, value):
         # django_rest_frameworks' default CharField implementation casts `None`
         # to a string `"None"`:
@@ -39,7 +35,6 @@ class CharField(CharField):
 
 
 class IntegerField(IntegerField):
-
     def get_value(self, dictionary):
         ret = super(IntegerField, self).get_value(dictionary)
         # Handle UI corner case
@@ -60,9 +55,7 @@ class StringListField(ListField):
 
 class StringListBooleanField(ListField):
 
-    default_error_messages = {
-        'type_error': _('Expected None, True, False, a string or list of strings but got {input_type} instead.'),
-    }
+    default_error_messages = {'type_error': _('Expected None, True, False, a string or list of strings but got {input_type} instead.')}
     child = CharField()
 
     def to_representation(self, value):
@@ -101,10 +94,7 @@ class StringListBooleanField(ListField):
 
 class StringListPathField(StringListField):
 
-    default_error_messages = {
-        'type_error': _('Expected list of strings but got {input_type} instead.'),
-        'path_error': _('{path} is not a valid path choice.'),
-    }
+    default_error_messages = {'type_error': _('Expected list of strings but got {input_type} instead.'), 'path_error': _('{path} is not a valid path choice.')}
 
     def to_internal_value(self, paths):
         if isinstance(paths, (list, tuple)):
@@ -123,12 +113,12 @@ class URLField(CharField):
     # these lines set up a custom regex that allow numbers in the
     # top-level domain
     tld_re = (
-        r'\.'                                              # dot
-        r'(?!-)'                                           # can't start with a dash
-        r'(?:[a-z' + URLValidator.ul + r'0-9' + '-]{2,63}' # domain label, this line was changed from the original URLValidator
-        r'|xn--[a-z0-9]{1,59})'                            # or punycode label
-        r'(?<!-)'                                          # can't end with a dash
-        r'\.?'                                             # may have a trailing dot
+        r'\.'  # dot
+        r'(?!-)'  # can't start with a dash
+        r'(?:[a-z' + URLValidator.ul + r'0-9' + '-]{2,63}'  # domain label, this line was changed from the original URLValidator
+        r'|xn--[a-z0-9]{1,59})'  # or punycode label
+        r'(?<!-)'  # can't end with a dash
+        r'\.?'  # may have a trailing dot
     )
 
     host_re = '(' + URLValidator.hostname_re + URLValidator.domain_re + tld_re + '|localhost)'
@@ -139,7 +129,9 @@ class URLField(CharField):
         r'(?:' + URLValidator.ipv4_re + '|' + URLValidator.ipv6_re + '|' + host_re + ')'
         r'(?::\d{2,5})?'  # port
         r'(?:[/?#][^\s]*)?'  # resource path
-        r'\Z', re.IGNORECASE)
+        r'\Z',
+        re.IGNORECASE,
+    )
 
     def __init__(self, **kwargs):
         schemes = kwargs.pop('schemes', None)
@@ -184,9 +176,7 @@ class URLField(CharField):
 
 class KeyValueField(DictField):
     child = CharField()
-    default_error_messages = {
-        'invalid_child': _('"{input}" is not a valid string.')
-    }
+    default_error_messages = {'invalid_child': _('"{input}" is not a valid string.')}
 
     def to_internal_value(self, data):
         ret = super(KeyValueField, self).to_internal_value(data)
@@ -199,9 +189,7 @@ class KeyValueField(DictField):
 
 
 class ListTuplesField(ListField):
-    default_error_messages = {
-        'type_error': _('Expected a list of tuples of max length 2 but got {input_type} instead.'),
-    }
+    default_error_messages = {'type_error': _('Expected a list of tuples of max length 2 but got {input_type} instead.')}
 
     def to_representation(self, value):
         if isinstance(value, (list, tuple)):

awx/conf/license.py

@@ -6,9 +6,10 @@ __all__ = ['get_license']
 
 def _get_validated_license_data():
     from awx.main.utils import get_licenser
+
     return get_licenser().validate()
 
 
 def get_license():
-    """Return a dictionary representing the active license on this Tower instance."""
+    """Return a dictionary representing the active license on this instance."""
     return _get_validated_license_data()

awx/conf/migrations/0001_initial.py

@@ -8,9 +8,7 @@ from django.conf import settings
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
-    ]
+    dependencies = [migrations.swappable_dependency(settings.AUTH_USER_MODEL)]
 
     operations = [
         migrations.CreateModel(
@@ -21,11 +19,11 @@ class Migration(migrations.Migration):
                 ('modified', models.DateTimeField(default=None, editable=False)),
                 ('key', models.CharField(max_length=255)),
                 ('value', jsonfield.fields.JSONField(null=True)),
-                ('user', models.ForeignKey(related_name='settings', default=None, editable=False,
-                                           to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE, null=True)),
+                (
+                    'user',
+                    models.ForeignKey(related_name='settings', default=None, editable=False, to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE, null=True),
+                ),
             ],
-            options={
-                'abstract': False,
-            },
-        ),
+            options={'abstract': False},
+        )
     ]

awx/conf/migrations/0002_v310_copy_tower_settings.py

@@ -15,11 +15,7 @@ def copy_tower_settings(apps, schema_editor):
             if tower_setting.key == 'LICENSE':
                 value = json.loads(value)
             setting, created = Setting.objects.get_or_create(
-                key=tower_setting.key,
-                user=tower_setting.user,
-                created=tower_setting.created,
-                modified=tower_setting.modified,
-                defaults=dict(value=value),
+                key=tower_setting.key, user=tower_setting.user, created=tower_setting.created, modified=tower_setting.modified, defaults=dict(value=value)
             )
             if not created and setting.value != value:
                 setting.value = value
@@ -36,18 +32,9 @@ def revert_tower_settings(apps, schema_editor):
         # LICENSE is stored as a JSON object; convert it back to a string.
         if setting.key == 'LICENSE':
             value = json.dumps(value)
-        defaults = dict(
-            value=value,
-            value_type='string',
-            description='',
-            category='',
-        )
+        defaults = dict(value=value, value_type='string', description='', category='')
         try:
-            tower_setting, created = TowerSettings.objects.get_or_create(
-                key=setting.key,
-                user=setting.user,
-                defaults=defaults,
-            )
+            tower_setting, created = TowerSettings.objects.get_or_create(key=setting.key, user=setting.user, defaults=defaults)
             if not created:
                 update_fields = []
                 for k, v in defaults.items():
@@ -62,15 +49,8 @@ def revert_tower_settings(apps, schema_editor):
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0001_initial'),
-        ('main', '0004_squashed_v310_release'),
-    ]
+    dependencies = [('conf', '0001_initial'), ('main', '0004_squashed_v310_release')]
 
-    run_before = [
-        ('main', '0005_squashed_v310_v313_updates'),
-    ]
+    run_before = [('main', '0005_squashed_v310_v313_updates')]
 
-    operations = [
-        migrations.RunPython(copy_tower_settings, revert_tower_settings),
-    ]
+    operations = [migrations.RunPython(copy_tower_settings, revert_tower_settings)]

awx/conf/migrations/0003_v310_JSONField_changes.py

@@ -7,14 +7,6 @@ import awx.main.fields
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0002_v310_copy_tower_settings'),
-    ]
+    dependencies = [('conf', '0002_v310_copy_tower_settings')]
 
-    operations = [
-        migrations.AlterField(
-            model_name='setting',
-            name='value',
-            field=awx.main.fields.JSONField(null=True),
-        ),
-    ]
+    operations = [migrations.AlterField(model_name='setting', name='value', field=awx.main.fields.JSONField(null=True))]

awx/conf/migrations/0004_v320_reencrypt.py

@@ -6,9 +6,7 @@ from django.db import migrations
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0003_v310_JSONField_changes'),
-    ]
+    dependencies = [('conf', '0003_v310_JSONField_changes')]
 
     operations = [
         # This list is intentionally empty.

awx/conf/migrations/0005_v330_rename_two_session_settings.py

@@ -2,8 +2,8 @@
 from __future__ import unicode_literals
 from django.db import migrations
 from awx.conf.migrations import _rename_setting
-    
-    
+
+
 def copy_session_settings(apps, schema_editor):
     _rename_setting.rename_setting(apps, schema_editor, old_key='AUTH_TOKEN_PER_USER', new_key='SESSIONS_PER_USER')
     _rename_setting.rename_setting(apps, schema_editor, old_key='AUTH_TOKEN_EXPIRATION', new_key='SESSION_COOKIE_AGE')
@@ -16,11 +16,6 @@ def reverse_copy_session_settings(apps, schema_editor):
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0004_v320_reencrypt'),
-    ]
-
-    operations = [
-        migrations.RunPython(copy_session_settings, reverse_copy_session_settings),
-    ]
+    dependencies = [('conf', '0004_v320_reencrypt')]
 
+    operations = [migrations.RunPython(copy_session_settings, reverse_copy_session_settings)]

awx/conf/migrations/0006_v331_ldap_group_type.py

@@ -9,10 +9,6 @@ from django.db import migrations
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0005_v330_rename_two_session_settings'),
-    ]
+    dependencies = [('conf', '0005_v330_rename_two_session_settings')]
 
-    operations = [
-        migrations.RunPython(fill_ldap_group_type_params),
-    ]
+    operations = [migrations.RunPython(fill_ldap_group_type_params)]

awx/conf/migrations/0007_v380_rename_more_settings.py

@@ -10,10 +10,6 @@ def copy_allowed_ips(apps, schema_editor):
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0006_v331_ldap_group_type'),
-    ]
+    dependencies = [('conf', '0006_v331_ldap_group_type')]
 
-    operations = [
-        migrations.RunPython(copy_allowed_ips),
-    ]
+    operations = [migrations.RunPython(copy_allowed_ips)]

awx/conf/migrations/0008_subscriptions.py

@@ -15,12 +15,6 @@ def _noop(apps, schema_editor):
 
 class Migration(migrations.Migration):
 
-    dependencies = [
-        ('conf', '0007_v380_rename_more_settings'),
-    ]
+    dependencies = [('conf', '0007_v380_rename_more_settings')]
 
-
-    operations = [
-        migrations.RunPython(clear_old_license, _noop),
-        migrations.RunPython(prefill_rh_credentials, _noop)
-    ]
+    operations = [migrations.RunPython(clear_old_license, _noop), migrations.RunPython(prefill_rh_credentials, _noop)]

awx/conf/migrations/0009_rename_proot_settings.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+from django.db import migrations
+from awx.conf.migrations import _rename_setting
+
+
+def rename_proot_settings(apps, schema_editor):
+    _rename_setting.rename_setting(apps, schema_editor, old_key='AWX_PROOT_BASE_PATH', new_key='AWX_ISOLATION_BASE_PATH')
+    _rename_setting.rename_setting(apps, schema_editor, old_key='AWX_PROOT_SHOW_PATHS', new_key='AWX_ISOLATION_SHOW_PATHS')
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [('conf', '0008_subscriptions')]
+
+    operations = [migrations.RunPython(rename_proot_settings)]

awx/conf/migrations/_ldap_group_type.py

@@ -1,4 +1,3 @@
-
 import inspect
 
 from django.conf import settings
@@ -16,10 +15,7 @@ def fill_ldap_group_type_params(apps, schema_editor):
         entry = qs[0]
         group_type_params = entry.value
     else:
-        entry = Setting(key='AUTH_LDAP_GROUP_TYPE_PARAMS',
-                        value=group_type_params,
-                        created=now(),
-                        modified=now())
+        entry = Setting(key='AUTH_LDAP_GROUP_TYPE_PARAMS', value=group_type_params, created=now(), modified=now())
 
     init_attrs = set(inspect.getargspec(group_type.__init__).args[1:])
     for k in list(group_type_params.keys()):

awx/conf/migrations/_reencrypt.py

@@ -11,15 +11,16 @@ __all__ = ['get_encryption_key', 'decrypt_field']
 
 
 def get_encryption_key(field_name, pk=None):
-    '''
+    """
     Generate key for encrypted password based on field name,
     ``settings.SECRET_KEY``, and instance pk (if available).
 
     :param pk: (optional) the primary key of the ``awx.conf.model.Setting``;
                can be omitted in situations where you're encrypting a setting
                that is not database-persistent (like a read-only setting)
-    '''
+    """
     from django.conf import settings
+
     h = hashlib.sha1()
     h.update(settings.SECRET_KEY)
     if pk is not None:
@@ -29,11 +30,11 @@ def get_encryption_key(field_name, pk=None):
 
 
 def decrypt_value(encryption_key, value):
-    raw_data = value[len('$encrypted$'):]
+    raw_data = value[len('$encrypted$') :]
     # If the encrypted string contains a UTF8 marker, discard it
     utf8 = raw_data.startswith('UTF8$')
     if utf8:
-        raw_data = raw_data[len('UTF8$'):]
+        raw_data = raw_data[len('UTF8$') :]
     algo, b64data = raw_data.split('$', 1)
     if algo != 'AES':
         raise ValueError('unsupported algorithm: %s' % algo)
@@ -48,9 +49,9 @@ def decrypt_value(encryption_key, value):
 
 
 def decrypt_field(instance, field_name, subfield=None):
-    '''
+    """
     Return content of the given instance and field name decrypted.
-    '''
+    """
     value = getattr(instance, field_name)
     if isinstance(value, dict) and subfield is not None:
         value = value[subfield]

awx/conf/migrations/_rename_setting.py

@@ -6,11 +6,11 @@ from django.conf import settings
 
 logger = logging.getLogger('awx.conf.settings')
 
-__all__ = ['rename_setting']    
-    
-    
+__all__ = ['rename_setting']
+
+
 def rename_setting(apps, schema_editor, old_key, new_key):
-    
+
     old_setting = None
     Setting = apps.get_model('conf', 'Setting')
     if Setting.objects.filter(key=new_key).exists() or hasattr(settings, new_key):
@@ -24,9 +24,4 @@ def rename_setting(apps, schema_editor, old_key, new_key):
     if hasattr(settings, old_key):
         old_setting = getattr(settings, old_key)
     if old_setting is not None:
-        Setting.objects.create(key=new_key, 
-                               value=old_setting, 
-                               created=now(),
-                               modified=now()
-                               )
-        
+        Setting.objects.create(key=new_key, value=old_setting, created=now(), modified=now())

awx/conf/migrations/_subscriptions.py

@@ -6,7 +6,7 @@ from awx.main.utils.encryption import decrypt_field, encrypt_field
 logger = logging.getLogger('awx.conf.settings')
 
 __all__ = ['clear_old_license', 'prefill_rh_credentials']
-    
+
 
 def clear_old_license(apps, schema_editor):
     Setting = apps.get_model('conf', 'Setting')
@@ -17,10 +17,7 @@ def _migrate_setting(apps, old_key, new_key, encrypted=False):
     Setting = apps.get_model('conf', 'Setting')
     if not Setting.objects.filter(key=old_key).exists():
         return
-    new_setting = Setting.objects.create(key=new_key,
-                                         created=now(),
-                                         modified=now()
-                                         )
+    new_setting = Setting.objects.create(key=new_key, created=now(), modified=now())
     if encrypted:
         new_setting.value = decrypt_field(Setting.objects.filter(key=old_key).first(), 'value')
         new_setting.value = encrypt_field(new_setting, 'value')

awx/conf/models.py

@@ -7,7 +7,7 @@ import json
 # Django
 from django.db import models
 
-# Tower
+# AWX
 from awx.main.models.base import CreatedModifiedModel, prevent_search
 from awx.main.fields import JSONField
 from awx.main.utils import encrypt_field
@@ -18,20 +18,9 @@ __all__ = ['Setting']
 
 class Setting(CreatedModifiedModel):
 
-    key = models.CharField(
-        max_length=255,
-    )
-    value = JSONField(
-        null=True,
-    )
-    user = prevent_search(models.ForeignKey(
-        'auth.User',
-        related_name='settings',
-        default=None,
-        null=True,
-        editable=False,
-        on_delete=models.CASCADE,
-    ))
+    key = models.CharField(max_length=255)
+    value = JSONField(null=True)
+    user = prevent_search(models.ForeignKey('auth.User', related_name='settings', default=None, null=True, editable=False, on_delete=models.CASCADE))
 
     def __str__(self):
         try:
@@ -66,6 +55,7 @@ class Setting(CreatedModifiedModel):
         # field and save again.
         if encrypted and new_instance:
             from awx.main.signals import disable_activity_stream
+
             with disable_activity_stream():
                 self.value = self._saved_value
                 self.save(update_fields=['value'])
@@ -82,6 +72,7 @@ class Setting(CreatedModifiedModel):
 import awx.conf.signals  # noqa
 
 from awx.main.registrar import activity_stream_registrar  # noqa
+
 activity_stream_registrar.connect(Setting)
 
 import awx.conf.access  # noqa

awx/conf/registry.py

@@ -69,10 +69,7 @@ class SettingsRegistry(object):
         return self._dependent_settings.get(setting, set())
 
     def get_registered_categories(self):
-        categories = {
-            'all': _('All'),
-            'changed': _('Changed'),
-        }
+        categories = {'all': _('All'), 'changed': _('Changed')}
         for setting, kwargs in self._registry.items():
             category_slug = kwargs.get('category_slug', None)
             if category_slug is None or category_slug in categories:
@@ -95,8 +92,7 @@ class SettingsRegistry(object):
                 continue
             if kwargs.get('category_slug', None) in slugs_to_ignore:
                 continue
-            if (read_only in {True, False} and kwargs.get('read_only', False) != read_only and
-                    setting not in ('INSTALL_UUID', 'AWX_ISOLATED_PRIVATE_KEY', 'AWX_ISOLATED_PUBLIC_KEY')):
+            if read_only in {True, False} and kwargs.get('read_only', False) != read_only and setting != 'INSTALL_UUID':
                 # Note: Doesn't catch fields that set read_only via __init__;
                 # read-only field kwargs should always include read_only=True.
                 continue
@@ -117,6 +113,7 @@ class SettingsRegistry(object):
 
     def get_setting_field(self, setting, mixin_class=None, for_user=False, **kwargs):
         from rest_framework.fields import empty
+
         field_kwargs = {}
         field_kwargs.update(self._registry[setting])
         field_kwargs.update(kwargs)
@@ -141,11 +138,7 @@ class SettingsRegistry(object):
             field_instance.placeholder = placeholder
         field_instance.defined_in_file = defined_in_file
         if field_instance.defined_in_file:
-            field_instance.help_text = (
-                str(_('This value has been set manually in a settings file.')) +
-                '\n\n' +
-                str(field_instance.help_text)
-            )
+            field_instance.help_text = str(_('This value has been set manually in a settings file.')) + '\n\n' + str(field_instance.help_text)
         field_instance.encrypted = encrypted
         original_field_instance = field_instance
         if field_class != original_field_class:

awx/conf/serializers.py

@@ -1,7 +1,7 @@
 # Django REST Framework
 from rest_framework import serializers
 
-# Tower
+# AWX
 from awx.api.fields import VerbatimField
 from awx.api.serializers import BaseSerializer
 from awx.conf.models import Setting
@@ -28,17 +28,11 @@ class SettingSerializer(BaseSerializer):
 
 
 class SettingCategorySerializer(serializers.Serializer):
-    """Serialize setting category """
+    """Serialize setting category"""
 
-    url = serializers.CharField(
-        read_only=True,
-    )
-    slug = serializers.CharField(
-        read_only=True,
-    )
-    name = serializers.CharField(
-        read_only=True,
-    )
+    url = serializers.CharField(read_only=True)
+    slug = serializers.CharField(read_only=True)
+    name = serializers.CharField(read_only=True)
 
 
 class SettingFieldMixin(object):
@@ -87,10 +81,8 @@ class SettingSingletonSerializer(serializers.Serializer):
             if self.instance and not hasattr(self.instance, key):
                 continue
             extra_kwargs = {}
-            # Make LICENSE and AWX_ISOLATED_KEY_GENERATION read-only here;
-            # LICENSE is only updated via /api/v2/config/
-            # AWX_ISOLATED_KEY_GENERATION is only set/unset via the setup playbook
-            if key in ('LICENSE', 'AWX_ISOLATED_KEY_GENERATION'):
+            # Make LICENSE read-only here; LICENSE is only updated via /api/v2/config/
+            if key == 'LICENSE':
                 extra_kwargs['read_only'] = True
             field = settings_registry.get_setting_field(key, mixin_class=SettingFieldMixin, for_user=bool(category_slug == 'user'), **extra_kwargs)
             fields[key] = field

awx/conf/settings.py

@@ -20,7 +20,7 @@ from rest_framework.fields import empty, SkipField
 
 import cachetools
 
-# Tower
+# AWX
 from awx.main.utils import encrypt_field, decrypt_field
 from awx.conf import settings_registry
 from awx.conf.models import Setting
@@ -62,12 +62,12 @@ __all__ = ['SettingsWrapper', 'get_settings_to_cache', 'SETTING_CACHE_NOTSET']
 
 @contextlib.contextmanager
 def _ctit_db_wrapper(trans_safe=False):
-    '''
+    """
     Wrapper to avoid undesired actions by Django ORM when managing settings
     if only getting a setting, can use trans_safe=True, which will avoid
     throwing errors if the prior context was a broken transaction.
     Any database errors will be logged, but exception will be suppressed.
-    '''
+    """
     rollback_set = None
     is_atomic = None
     try:
@@ -115,7 +115,6 @@ class TransientSetting(object):
 
 
 class EncryptedCacheProxy(object):
-
     def __init__(self, cache, registry, encrypter=None, decrypter=None):
         """
         This proxy wraps a Django cache backend and overwrites the
@@ -145,19 +144,11 @@ class EncryptedCacheProxy(object):
 
     def set(self, key, value, log=True, **kwargs):
         if log is True:
-            logger.debug('cache set(%r, %r, %r)', key, filter_sensitive(self.registry, key, value),
-                         SETTING_CACHE_TIMEOUT)
-        self.cache.set(
-            key,
-            self._handle_encryption(self.encrypter, key, value),
-            **kwargs
-        )
+            logger.debug('cache set(%r, %r, %r)', key, filter_sensitive(self.registry, key, value), SETTING_CACHE_TIMEOUT)
+        self.cache.set(key, self._handle_encryption(self.encrypter, key, value), **kwargs)
 
     def set_many(self, data, **kwargs):
-        filtered_data = dict(
-            (key, filter_sensitive(self.registry, key, value))
-            for key, value in data.items()
-        )
+        filtered_data = dict((key, filter_sensitive(self.registry, key, value)) for key, value in data.items())
         logger.debug('cache set_many(%r, %r)', filtered_data, SETTING_CACHE_TIMEOUT)
         for key, value in data.items():
             self.set(key, value, log=False, **kwargs)
@@ -168,18 +159,11 @@ class EncryptedCacheProxy(object):
             # as part of the AES key when encrypting/decrypting
             obj_id = self.cache.get(Setting.get_cache_id_key(key), default=empty)
             if obj_id is empty:
-                logger.info('Efficiency notice: Corresponding id not stored in cache %s',
-                            Setting.get_cache_id_key(key))
+                logger.info('Efficiency notice: Corresponding id not stored in cache %s', Setting.get_cache_id_key(key))
                 obj_id = getattr(self._get_setting_from_db(key), 'pk', None)
             elif obj_id == SETTING_CACHE_NONE:
                 obj_id = None
-            return method(
-                TransientSetting(
-                    pk=obj_id,
-                    value=value
-                ),
-                'value'
-            )
+            return method(TransientSetting(pk=obj_id, value=value), 'value')
 
         # If the field in question isn't an "encrypted" field, this function is
         # a no-op; it just returns the provided value
@@ -206,9 +190,9 @@ def get_settings_to_cache(registry):
 
 
 def get_cache_value(value):
-    '''Returns the proper special cache setting for a value
+    """Returns the proper special cache setting for a value
     based on instance type.
-    '''
+    """
     if value is None:
         value = SETTING_CACHE_NONE
     elif isinstance(value, (list, tuple)) and len(value) == 0:
@@ -219,7 +203,6 @@ def get_cache_value(value):
 
 
 class SettingsWrapper(UserSettingsHolder):
-
     @classmethod
     def initialize(cls, cache=None, registry=None):
         """
@@ -231,11 +214,7 @@ class SettingsWrapper(UserSettingsHolder):
         ``awx.conf.settings_registry`` is used by default.
         """
         if not getattr(settings, '_awx_conf_settings', False):
-            settings_wrapper = cls(
-                settings._wrapped,
-                cache=cache or django_cache,
-                registry=registry or settings_registry
-            )
+            settings_wrapper = cls(settings._wrapped, cache=cache or django_cache, registry=registry or settings_registry)
             settings._wrapped = settings_wrapper
 
     def __init__(self, default_settings, cache, registry):
@@ -322,7 +301,7 @@ class SettingsWrapper(UserSettingsHolder):
                 try:
                     value = decrypt_field(setting, 'value')
                 except ValueError as e:
-                    #TODO: Remove in Tower 3.3
+                    # TODO: Remove in Tower 3.3
                     logger.debug('encountered error decrypting field: %s - attempting fallback to old', e)
                     value = old_decrypt_field(setting, 'value')
 
@@ -345,8 +324,7 @@ class SettingsWrapper(UserSettingsHolder):
         # Generate a cache key for each setting and store them all at once.
         settings_to_cache = dict([(Setting.get_cache_key(k), v) for k, v in settings_to_cache.items()])
         for k, id_val in setting_ids.items():
-            logger.debug('Saving id in cache for encrypted setting %s, %s',
-                         Setting.get_cache_id_key(k), id_val)
+            logger.debug('Saving id in cache for encrypted setting %s, %s', Setting.get_cache_id_key(k), id_val)
             self.cache.cache.set(Setting.get_cache_id_key(k), id_val)
         settings_to_cache['_awx_conf_preload_expires'] = self._awx_conf_preload_expires
         self.cache.set_many(settings_to_cache, timeout=SETTING_CACHE_TIMEOUT)
@@ -372,13 +350,8 @@ class SettingsWrapper(UserSettingsHolder):
         if value is empty:
             setting = None
             setting_id = None
-            if not field.read_only or name in (
-                # these values are read-only - however - we *do* want
-                # to fetch their value from the database
-                'INSTALL_UUID',
-                'AWX_ISOLATED_PRIVATE_KEY',
-                'AWX_ISOLATED_PUBLIC_KEY',
-            ):
+            # this value is read-only, however we *do* want to fetch its value from the database
+            if not field.read_only or name == 'INSTALL_UUID':
                 setting = Setting.objects.filter(key=name, user__isnull=True).order_by('pk').first()
             if setting:
                 if getattr(field, 'encrypted', False):
@@ -420,9 +393,7 @@ class SettingsWrapper(UserSettingsHolder):
                     else:
                         return value
             except Exception:
-                logger.warning(
-                    'The current value "%r" for setting "%s" is invalid.',
-                    value, name, exc_info=True)
+                logger.warning('The current value "%r" for setting "%s" is invalid.', value, name, exc_info=True)
         return empty
 
     def _get_default(self, name):
@@ -453,8 +424,7 @@ class SettingsWrapper(UserSettingsHolder):
             setting_value = field.run_validation(data)
             db_value = field.to_representation(setting_value)
         except Exception as e:
-            logger.exception('Unable to assign value "%r" to setting "%s".',
-                             value, name, exc_info=True)
+            logger.exception('Unable to assign value "%r" to setting "%s".', value, name, exc_info=True)
             raise e
 
         setting = Setting.objects.filter(key=name, user__isnull=True).order_by('pk').first()
@@ -492,8 +462,7 @@ class SettingsWrapper(UserSettingsHolder):
     def __dir__(self):
         keys = []
         with _ctit_db_wrapper(trans_safe=True):
-            for setting in Setting.objects.filter(
-                    key__in=self.all_supported_settings, user__isnull=True):
+            for setting in Setting.objects.filter(key__in=self.all_supported_settings, user__isnull=True):
                 # Skip returning settings that have been overridden but are
                 # considered to be "not set".
                 if setting.value is None and SETTING_CACHE_NOTSET == SETTING_CACHE_NONE:
@@ -511,7 +480,7 @@ class SettingsWrapper(UserSettingsHolder):
             with _ctit_db_wrapper(trans_safe=True):
                 set_locally = Setting.objects.filter(key=setting, user__isnull=True).exists()
         set_on_default = getattr(self.default_settings, 'is_overridden', lambda s: False)(setting)
-        return (set_locally or set_on_default)
+        return set_locally or set_on_default
 
 
 def __getattr_without_cache__(self, name):

awx/conf/signals.py

@@ -8,7 +8,7 @@ from django.db.models.signals import post_save, pre_delete, post_delete
 from django.core.cache import cache
 from django.dispatch import receiver
 
-# Tower
+# AWX
 from awx.conf import settings_registry
 from awx.conf.models import Setting
 
@@ -30,12 +30,7 @@ def handle_setting_change(key, for_delete=False):
 
     # Send setting_changed signal with new value for each setting.
     for setting_key in setting_keys:
-        setting_changed.send(
-            sender=Setting,
-            setting=setting_key,
-            value=getattr(settings, setting_key, None),
-            enter=not bool(for_delete),
-        )
+        setting_changed.send(sender=Setting, setting=setting_key, value=getattr(settings, setting_key, None), enter=not bool(for_delete))
 
 
 @receiver(post_save, sender=Setting)

awx/conf/tests/functional/conftest.py

@@ -5,10 +5,7 @@ import pytest
 from django.urls import resolve
 from django.contrib.auth.models import User
 
-from rest_framework.test import (
-    APIRequestFactory,
-    force_authenticate,
-)
+from rest_framework.test import APIRequestFactory, force_authenticate
 
 
 @pytest.fixture
@@ -41,4 +38,5 @@ def api_request(admin):
         response = view(request, *view_args, **view_kwargs)
         response.render()
         return response
+
     return rf

awx/conf/tests/functional/test_api.py

@@ -45,44 +45,19 @@ def dummy_validate():
 
 @pytest.mark.django_db
 def test_non_admin_user_does_not_see_categories(api_request, dummy_setting, normal_user):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
-    ):
-        response = api_request(
-            'get',
-            reverse('api:setting_category_list',
-                    kwargs={'version': 'v2'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'):
+        response = api_request('get', reverse('api:setting_category_list', kwargs={'version': 'v2'}))
         assert response.data['results']
-        response = api_request(
-            'get',
-            reverse('api:setting_category_list',
-                    kwargs={'version': 'v2'}),
-            user=normal_user
-        )
+        response = api_request('get', reverse('api:setting_category_list', kwargs={'version': 'v2'}), user=normal_user)
         assert not response.data['results']
 
 
 @pytest.mark.django_db
 def test_setting_singleton_detail_retrieve(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR_1',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
-    ), dummy_setting(
-        'FOO_BAR_2',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
+    with dummy_setting('FOO_BAR_1', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'), dummy_setting(
+        'FOO_BAR_2', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'
     ):
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.status_code == 200
         assert 'FOO_BAR_1' in response.data and response.data['FOO_BAR_1'] is None
         assert 'FOO_BAR_2' in response.data and response.data['FOO_BAR_2'] is None
@@ -90,97 +65,43 @@ def test_setting_singleton_detail_retrieve(api_request, dummy_setting):
 
 @pytest.mark.django_db
 def test_setting_singleton_detail_invalid_retrieve(api_request, dummy_setting, normal_user):
-    with dummy_setting(
-        'FOO_BAR_1',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
-    ), dummy_setting(
-        'FOO_BAR_2',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
+    with dummy_setting('FOO_BAR_1', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'), dummy_setting(
+        'FOO_BAR_2', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'
     ):
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'barfoo'})
-        )
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'barfoo'}))
         assert response.status_code == 404
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            user = normal_user
-        )
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), user=normal_user)
         assert response.status_code == 403
 
 
 @pytest.mark.django_db
 def test_setting_signleton_retrieve_hierachy(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        default=0,
-        category='FooBar',
-        category_slug='foobar'
-    ):
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, default=0, category='FooBar', category_slug='foobar'):
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 0
         s = Setting(key='FOO_BAR', value=1)
         s.save()
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 1
 
 
 @pytest.mark.django_db
 def test_setting_singleton_retrieve_readonly(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        read_only=True,
-        default=2,
-        category='FooBar',
-        category_slug='foobar'
-    ):
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, read_only=True, default=2, category='FooBar', category_slug='foobar'):
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 2
 
 
 @pytest.mark.django_db
 def test_setting_singleton_update(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
-    ), mock.patch('awx.conf.views.handle_setting_changes'):
-        api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': 3}
-        )
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'), mock.patch(
+        'awx.conf.views.handle_setting_changes'
+    ):
+        api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': 3})
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 3
-        api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': 4}
-        )
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+        api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': 4})
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 4
 
 
@@ -190,138 +111,70 @@ def test_setting_singleton_update_hybriddictfield_with_forbidden(api_request, du
     # indicating that only the defined fields can be filled in.  Make
     # sure that the _Forbidden validator doesn't get used for the
     # fields.  See also https://github.com/ansible/awx/issues/4099.
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=sso_fields.SAMLOrgAttrField,
-        category='FooBar',
-        category_slug='foobar',
-    ), mock.patch('awx.conf.views.handle_setting_changes'):
+    with dummy_setting('FOO_BAR', field_class=sso_fields.SAMLOrgAttrField, category='FooBar', category_slug='foobar'), mock.patch(
+        'awx.conf.views.handle_setting_changes'
+    ):
         api_request(
             'patch',
             reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': {'saml_admin_attr': 'Admins', 'saml_attr': 'Orgs'}}
-        )
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
+            data={'FOO_BAR': {'saml_admin_attr': 'Admins', 'saml_attr': 'Orgs'}},
         )
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == {'saml_admin_attr': 'Admins', 'saml_attr': 'Orgs'}
 
 
 @pytest.mark.django_db
 def test_setting_singleton_update_dont_change_readonly_fields(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        read_only=True,
-        default=4,
-        category='FooBar',
-        category_slug='foobar'
-    ), mock.patch('awx.conf.views.handle_setting_changes'):
-        api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': 5}
-        )
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, read_only=True, default=4, category='FooBar', category_slug='foobar'), mock.patch(
+        'awx.conf.views.handle_setting_changes'
+    ):
+        api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': 5})
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 4
 
 
 @pytest.mark.django_db
 def test_setting_singleton_update_dont_change_encrypted_mark(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.CharField,
-        encrypted=True,
-        category='FooBar',
-        category_slug='foobar'
-    ), mock.patch('awx.conf.views.handle_setting_changes'):
-        api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': 'password'}
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.CharField, encrypted=True, category='FooBar', category_slug='foobar'), mock.patch(
+        'awx.conf.views.handle_setting_changes'
+    ):
+        api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': 'password'})
         assert Setting.objects.get(key='FOO_BAR').value.startswith('$encrypted$')
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == '$encrypted$'
-        api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': '$encrypted$'}
-        )
+        api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': '$encrypted$'})
         assert decrypt_field(Setting.objects.get(key='FOO_BAR'), 'value') == 'password'
-        api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': 'new_pw'}
-        )
+        api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': 'new_pw'})
         assert decrypt_field(Setting.objects.get(key='FOO_BAR'), 'value') == 'new_pw'
 
 
 @pytest.mark.django_db
 def test_setting_singleton_update_runs_custom_validate(api_request, dummy_setting, dummy_validate):
-
     def func_raising_exception(serializer, attrs):
         raise serializers.ValidationError('Error')
 
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
-    ), dummy_validate(
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'), dummy_validate(
         'foobar', func_raising_exception
     ), mock.patch('awx.conf.views.handle_setting_changes'):
-        response = api_request(
-            'patch',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}),
-            data={'FOO_BAR': 23}
-        )
+        response = api_request('patch', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}), data={'FOO_BAR': 23})
         assert response.status_code == 400
 
 
 @pytest.mark.django_db
 def test_setting_singleton_delete(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        category='FooBar',
-        category_slug='foobar'
-    ), mock.patch('awx.conf.views.handle_setting_changes'):
-        api_request(
-            'delete',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, category='FooBar', category_slug='foobar'), mock.patch(
+        'awx.conf.views.handle_setting_changes'
+    ):
+        api_request('delete', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert not response.data['FOO_BAR']
 
 
 @pytest.mark.django_db
 def test_setting_singleton_delete_no_read_only_fields(api_request, dummy_setting):
-    with dummy_setting(
-        'FOO_BAR',
-        field_class=fields.IntegerField,
-        read_only=True,
-        default=23,
-        category='FooBar',
-        category_slug='foobar'
-    ), mock.patch('awx.conf.views.handle_setting_changes'):
-        api_request(
-            'delete',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
-        response = api_request(
-            'get',
-            reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'})
-        )
+    with dummy_setting('FOO_BAR', field_class=fields.IntegerField, read_only=True, default=23, category='FooBar', category_slug='foobar'), mock.patch(
+        'awx.conf.views.handle_setting_changes'
+    ):
+        api_request('delete', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
+        response = api_request('get', reverse('api:setting_singleton_detail', kwargs={'category_slug': 'foobar'}))
         assert response.data['FOO_BAR'] == 23
-

awx/conf/tests/test_env.py

@@ -1,5 +1,3 @@
-
-
 # Ensure that our autouse overwrites are working
 def test_cache(settings):
     assert settings.CACHES['default']['BACKEND'] == 'django.core.cache.backends.locmem.LocMemCache'

awx/conf/tests/unit/test_fields.py

@@ -4,7 +4,7 @@ from rest_framework.fields import ValidationError
 from awx.conf.fields import StringListBooleanField, StringListPathField, ListTuplesField, URLField
 
 
-class TestStringListBooleanField():
+class TestStringListBooleanField:
 
     FIELD_VALUES = [
         ("hello", "hello"),
@@ -23,10 +23,7 @@ class TestStringListBooleanField():
         ("NULL", None),
     ]
 
-    FIELD_VALUES_INVALID = [
-        1.245,
-        {"a": "b"},
-    ]
+    FIELD_VALUES_INVALID = [1.245, {"a": "b"}]
 
     @pytest.mark.parametrize("value_in, value_known", FIELD_VALUES)
     def test_to_internal_value_valid(self, value_in, value_known):
@@ -39,8 +36,7 @@ class TestStringListBooleanField():
         field = StringListBooleanField()
         with pytest.raises(ValidationError) as e:
             field.to_internal_value(value)
-        assert e.value.detail[0] == "Expected None, True, False, a string or list " \
-            "of strings but got {} instead.".format(type(value))
+        assert e.value.detail[0] == "Expected None, True, False, a string or list " "of strings but got {} instead.".format(type(value))
 
     @pytest.mark.parametrize("value_in, value_known", FIELD_VALUES)
     def test_to_representation_valid(self, value_in, value_known):
@@ -53,22 +49,14 @@ class TestStringListBooleanField():
         field = StringListBooleanField()
         with pytest.raises(ValidationError) as e:
             field.to_representation(value)
-        assert e.value.detail[0] == "Expected None, True, False, a string or list " \
-            "of strings but got {} instead.".format(type(value))
+        assert e.value.detail[0] == "Expected None, True, False, a string or list " "of strings but got {} instead.".format(type(value))
 
 
-class TestListTuplesField():
+class TestListTuplesField:
 
-    FIELD_VALUES = [
-        ([('a', 'b'), ('abc', '123')], [("a", "b"), ("abc", "123")]),
-    ]
+    FIELD_VALUES = [([('a', 'b'), ('abc', '123')], [("a", "b"), ("abc", "123")])]
 
-    FIELD_VALUES_INVALID = [
-        ("abc", type("abc")),
-        ([('a', 'b', 'c'), ('abc', '123', '456')], type(('a',))),
-        (['a', 'b'], type('a')),
-        (123, type(123)),
-    ]
+    FIELD_VALUES_INVALID = [("abc", type("abc")), ([('a', 'b', 'c'), ('abc', '123', '456')], type(('a',))), (['a', 'b'], type('a')), (123, type(123))]
 
     @pytest.mark.parametrize("value_in, value_known", FIELD_VALUES)
     def test_to_internal_value_valid(self, value_in, value_known):
@@ -81,11 +69,10 @@ class TestListTuplesField():
         field = ListTuplesField()
         with pytest.raises(ValidationError) as e:
             field.to_internal_value(value)
-        assert e.value.detail[0] == "Expected a list of tuples of max length 2 " \
-            "but got {} instead.".format(t)
+        assert e.value.detail[0] == "Expected a list of tuples of max length 2 " "but got {} instead.".format(t)
 
 
-class TestStringListPathField():
+class TestStringListPathField:
 
     FIELD_VALUES = [
         ((".", "..", "/"), [".", "..", "/"]),
@@ -93,22 +80,12 @@ class TestStringListPathField():
         (("///home///",), ["/home"]),
         (("/home/././././",), ["/home"]),
         (("/home", "/home", "/home/"), ["/home"]),
-        (["/home/", "/home/", "/opt/", "/opt/", "/var/"], ["/home", "/opt", "/var"])
+        (["/home/", "/home/", "/opt/", "/opt/", "/var/"], ["/home", "/opt", "/var"]),
     ]
 
-    FIELD_VALUES_INVALID_TYPE = [
-        1.245,
-        {"a": "b"},
-        ("/home"),
-    ]
+    FIELD_VALUES_INVALID_TYPE = [1.245, {"a": "b"}, ("/home")]
 
-    FIELD_VALUES_INVALID_PATH = [
-        "",
-        "~/",
-        "home",
-        "/invalid_path",
-        "/home/invalid_path",
-    ]
+    FIELD_VALUES_INVALID_PATH = ["", "~/", "home", "/invalid_path", "/home/invalid_path"]
 
     @pytest.mark.parametrize("value_in, value_known", FIELD_VALUES)
     def test_to_internal_value_valid(self, value_in, value_known):
@@ -131,16 +108,19 @@ class TestStringListPathField():
         assert e.value.detail[0] == "{} is not a valid path choice.".format(value)
 
 
-class TestURLField():
+class TestURLField:
     regex = "^https://www.example.org$"
 
-    @pytest.mark.parametrize("url,schemes,regex, allow_numbers_in_top_level_domain, expect_no_error",[
-        ("ldap://www.example.org42", "ldap", None, True, True),
-        ("https://www.example.org42", "https", None, False, False),
-        ("https://www.example.org", None,  regex, None, True),
-        ("https://www.example3.org", None, regex, None, False),
-        ("ftp://www.example.org", "https", None, None, False)
-    ])
+    @pytest.mark.parametrize(
+        "url,schemes,regex, allow_numbers_in_top_level_domain, expect_no_error",
+        [
+            ("ldap://www.example.org42", "ldap", None, True, True),
+            ("https://www.example.org42", "https", None, False, False),
+            ("https://www.example.org", None, regex, None, True),
+            ("https://www.example3.org", None, regex, None, False),
+            ("ftp://www.example.org", "https", None, None, False),
+        ],
+    )
     def test_urls(self, url, schemes, regex, allow_numbers_in_top_level_domain, expect_no_error):
         kwargs = {}
         kwargs.setdefault("allow_numbers_in_top_level_domain", allow_numbers_in_top_level_domain)

awx/conf/tests/unit/test_registry.py

@@ -33,30 +33,18 @@ def reg(request):
         if marker.name == 'defined_in_file':
             settings.configure(**marker.kwargs)
 
-    settings._wrapped = SettingsWrapper(settings._wrapped,
-                                        cache,
-                                        registry)
+    settings._wrapped = SettingsWrapper(settings._wrapped, cache, registry)
     return registry
 
 
 def test_simple_setting_registration(reg):
     assert reg.get_registered_settings() == []
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system',
-    )
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
     assert reg.get_registered_settings() == ['AWX_SOME_SETTING_ENABLED']
 
 
 def test_simple_setting_unregistration(reg):
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system',
-    )
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
     assert reg.get_registered_settings() == ['AWX_SOME_SETTING_ENABLED']
 
     reg.unregister('AWX_SOME_SETTING_ENABLED')
@@ -67,12 +55,7 @@ def test_duplicate_setting_registration(reg):
     "ensure that settings cannot be registered twice."
     with pytest.raises(ImproperlyConfigured):
         for i in range(2):
-            reg.register(
-                'AWX_SOME_SETTING_ENABLED',
-                field_class=fields.BooleanField,
-                category=_('System'),
-                category_slug='system',
-            )
+            reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
 
 
 def test_field_class_required_for_registration(reg):
@@ -82,110 +65,42 @@ def test_field_class_required_for_registration(reg):
 
 
 def test_get_registered_settings_by_slug(reg):
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system',
-    )
-    assert reg.get_registered_settings(category_slug='system') == [
-        'AWX_SOME_SETTING_ENABLED'
-    ]
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
+    assert reg.get_registered_settings(category_slug='system') == ['AWX_SOME_SETTING_ENABLED']
     assert reg.get_registered_settings(category_slug='other') == []
 
 
 def test_get_registered_read_only_settings(reg):
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system'
-    )
-    reg.register(
-        'AWX_SOME_READ_ONLY',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system',
-        read_only=True
-    )
-    assert reg.get_registered_settings(read_only=True) ==[
-        'AWX_SOME_READ_ONLY'
-    ]
-    assert reg.get_registered_settings(read_only=False) == [
-        'AWX_SOME_SETTING_ENABLED'
-    ]
-    assert reg.get_registered_settings() == [
-        'AWX_SOME_SETTING_ENABLED',
-        'AWX_SOME_READ_ONLY'
-    ]
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
+    reg.register('AWX_SOME_READ_ONLY', field_class=fields.BooleanField, category=_('System'), category_slug='system', read_only=True)
+    assert reg.get_registered_settings(read_only=True) == ['AWX_SOME_READ_ONLY']
+    assert reg.get_registered_settings(read_only=False) == ['AWX_SOME_SETTING_ENABLED']
+    assert reg.get_registered_settings() == ['AWX_SOME_SETTING_ENABLED', 'AWX_SOME_READ_ONLY']
 
 
 def test_get_dependent_settings(reg):
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
     reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system'
+        'AWX_SOME_DEPENDENT_SETTING', field_class=fields.BooleanField, category=_('System'), category_slug='system', depends_on=['AWX_SOME_SETTING_ENABLED']
     )
-    reg.register(
-        'AWX_SOME_DEPENDENT_SETTING',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system',
-        depends_on=['AWX_SOME_SETTING_ENABLED']
-    )
-    assert reg.get_dependent_settings('AWX_SOME_SETTING_ENABLED') == set([
-        'AWX_SOME_DEPENDENT_SETTING'
-    ])
+    assert reg.get_dependent_settings('AWX_SOME_SETTING_ENABLED') == set(['AWX_SOME_DEPENDENT_SETTING'])
 
 
 def test_get_registered_categories(reg):
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('System'),
-        category_slug='system'
-    )
-    reg.register(
-        'AWX_SOME_OTHER_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category=_('OtherSystem'),
-        category_slug='other-system'
-    )
-    assert reg.get_registered_categories() == {
-        'all': _('All'),
-        'changed': _('Changed'),
-        'system': _('System'),
-        'other-system': _('OtherSystem'),
-    }
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category=_('System'), category_slug='system')
+    reg.register('AWX_SOME_OTHER_SETTING_ENABLED', field_class=fields.BooleanField, category=_('OtherSystem'), category_slug='other-system')
+    assert reg.get_registered_categories() == {'all': _('All'), 'changed': _('Changed'), 'system': _('System'), 'other-system': _('OtherSystem')}
 
 
 def test_is_setting_encrypted(reg):
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
-    reg.register(
-        'AWX_SOME_ENCRYPTED_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        encrypted=True
-    )
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.CharField, category=_('System'), category_slug='system')
+    reg.register('AWX_SOME_ENCRYPTED_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', encrypted=True)
     assert reg.is_setting_encrypted('AWX_SOME_SETTING_ENABLED') is False
     assert reg.is_setting_encrypted('AWX_SOME_ENCRYPTED_SETTING') is True
 
 
 def test_simple_field(reg):
-    reg.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        placeholder='Example Value',
-    )
+    reg.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', placeholder='Example Value')
 
     field = reg.get_setting_field('AWX_SOME_SETTING')
     assert isinstance(field, fields.CharField)
@@ -196,31 +111,20 @@ def test_simple_field(reg):
 
 
 def test_field_with_custom_attribute(reg):
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category_slug='system',
-    )
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category_slug='system')
 
-    field = reg.get_setting_field('AWX_SOME_SETTING_ENABLED',
-                                  category_slug='other-system')
+    field = reg.get_setting_field('AWX_SOME_SETTING_ENABLED', category_slug='other-system')
     assert field.category_slug == 'other-system'
 
 
 def test_field_with_custom_mixin(reg):
     class GreatMixin(object):
-
         def is_great(self):
             return True
 
-    reg.register(
-        'AWX_SOME_SETTING_ENABLED',
-        field_class=fields.BooleanField,
-        category_slug='system',
-    )
+    reg.register('AWX_SOME_SETTING_ENABLED', field_class=fields.BooleanField, category_slug='system')
 
-    field = reg.get_setting_field('AWX_SOME_SETTING_ENABLED',
-                                  mixin_class=GreatMixin)
+    field = reg.get_setting_field('AWX_SOME_SETTING_ENABLED', mixin_class=GreatMixin)
     assert isinstance(field, fields.BooleanField)
     assert isinstance(field, GreatMixin)
     assert field.is_great() is True
@@ -228,12 +132,7 @@ def test_field_with_custom_mixin(reg):
 
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_default_value_from_settings(reg):
-    reg.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-    )
+    reg.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
 
     field = reg.get_setting_field('AWX_SOME_SETTING')
     assert field.default == 'DEFAULT'
@@ -242,16 +141,10 @@ def test_default_value_from_settings(reg):
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_default_value_from_settings_with_custom_representation(reg):
     class LowercaseCharField(fields.CharField):
-
         def to_representation(self, value):
             return value.lower()
 
-    reg.register(
-        'AWX_SOME_SETTING',
-        field_class=LowercaseCharField,
-        category=_('System'),
-        category_slug='system',
-    )
+    reg.register('AWX_SOME_SETTING', field_class=LowercaseCharField, category=_('System'), category_slug='system')
 
     field = reg.get_setting_field('AWX_SOME_SETTING')
     assert field.default == 'default'

awx/conf/tests/unit/test_settings.py

@@ -53,9 +53,7 @@ def settings(request):
 
     defaults['DEFAULTS_SNAPSHOT'] = {}
     settings.configure(**defaults)
-    settings._wrapped = SettingsWrapper(settings._wrapped,
-                                        cache,
-                                        registry)
+    settings._wrapped = SettingsWrapper(settings._wrapped, cache, registry)
     return settings
 
 
@@ -67,14 +65,7 @@ def test_unregistered_setting(settings):
 
 
 def test_read_only_setting(settings):
-    settings.registry.register(
-        'AWX_READ_ONLY',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        default='NO-EDITS',
-        read_only=True
-    )
+    settings.registry.register('AWX_READ_ONLY', field_class=fields.CharField, category=_('System'), category_slug='system', default='NO-EDITS', read_only=True)
     assert settings.AWX_READ_ONLY == 'NO-EDITS'
     assert len(settings.registry.get_registered_settings(read_only=False)) == 0
     settings = settings.registry.get_registered_settings(read_only=True)
@@ -85,13 +76,7 @@ def test_read_only_setting(settings):
 @pytest.mark.parametrize('read_only', [True, False])
 def test_setting_defined_in_file(settings, read_only):
     kwargs = {'read_only': True} if read_only else {}
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        **kwargs
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', **kwargs)
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     assert len(settings.registry.get_registered_settings(read_only=False)) == 0
     settings = settings.registry.get_registered_settings(read_only=True)
@@ -100,13 +85,7 @@ def test_setting_defined_in_file(settings, read_only):
 
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_setting_defined_in_file_with_empty_default(settings):
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        default='',
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', default='')
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     assert len(settings.registry.get_registered_settings(read_only=False)) == 0
     settings = settings.registry.get_registered_settings(read_only=True)
@@ -115,13 +94,7 @@ def test_setting_defined_in_file_with_empty_default(settings):
 
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_setting_defined_in_file_with_specific_default(settings):
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        default=123
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', default=123)
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     assert len(settings.registry.get_registered_settings(read_only=False)) == 0
     settings = settings.registry.get_registered_settings(read_only=True)
@@ -131,12 +104,7 @@ def test_setting_defined_in_file_with_specific_default(settings):
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_read_only_defaults_are_cached(settings):
     "read-only settings are stored in the cache"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     assert settings.cache.get('AWX_SOME_SETTING') == 'DEFAULT'
 
@@ -144,12 +112,7 @@ def test_read_only_defaults_are_cached(settings):
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_cache_respects_timeout(settings):
     "only preload the cache every SETTING_CACHE_TIMEOUT settings"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
 
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     cache_expiration = settings.cache.get('_awx_conf_preload_expires')
@@ -161,13 +124,7 @@ def test_cache_respects_timeout(settings):
 
 def test_default_setting(settings, mocker):
     "settings that specify a default are inserted into the cache"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        default='DEFAULT'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', default='DEFAULT')
 
     settings_to_cache = mocker.Mock(**{'order_by.return_value': []})
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=settings_to_cache):
@@ -177,24 +134,13 @@ def test_default_setting(settings, mocker):
 
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_setting_is_from_setting_file(settings, mocker):
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     assert settings.registry.get_setting_field('AWX_SOME_SETTING').defined_in_file is True
 
 
 def test_setting_is_not_from_setting_file(settings, mocker):
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        default='DEFAULT'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', default='DEFAULT')
 
     settings_to_cache = mocker.Mock(**{'order_by.return_value': []})
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=settings_to_cache):
@@ -204,19 +150,9 @@ def test_setting_is_not_from_setting_file(settings, mocker):
 
 def test_empty_setting(settings, mocker):
     "settings with no default and no defined value are not valid"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
 
-    mocks = mocker.Mock(**{
-        'order_by.return_value': mocker.Mock(**{
-            '__iter__': lambda self: iter([]),
-            'first.return_value': None
-        }),
-    })
+    mocks = mocker.Mock(**{'order_by.return_value': mocker.Mock(**{'__iter__': lambda self: iter([]), 'first.return_value': None})})
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=mocks):
         with pytest.raises(AttributeError):
             settings.AWX_SOME_SETTING
@@ -225,21 +161,10 @@ def test_empty_setting(settings, mocker):
 
 def test_setting_from_db(settings, mocker):
     "settings can be loaded from the database"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        default='DEFAULT'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', default='DEFAULT')
 
     setting_from_db = mocker.Mock(key='AWX_SOME_SETTING', value='FROM_DB')
-    mocks = mocker.Mock(**{
-        'order_by.return_value': mocker.Mock(**{
-            '__iter__': lambda self: iter([setting_from_db]),
-            'first.return_value': setting_from_db
-        }),
-    })
+    mocks = mocker.Mock(**{'order_by.return_value': mocker.Mock(**{'__iter__': lambda self: iter([setting_from_db]), 'first.return_value': setting_from_db})})
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=mocks):
         assert settings.AWX_SOME_SETTING == 'FROM_DB'
         assert settings.cache.get('AWX_SOME_SETTING') == 'FROM_DB'
@@ -248,12 +173,7 @@ def test_setting_from_db(settings, mocker):
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_read_only_setting_assignment(settings):
     "read-only settings cannot be overwritten"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     with pytest.raises(ImproperlyConfigured):
         settings.AWX_SOME_SETTING = 'CHANGED'
@@ -262,41 +182,26 @@ def test_read_only_setting_assignment(settings):
 
 def test_db_setting_create(settings, mocker):
     "settings are stored in the database when set for the first time"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
 
     setting_list = mocker.Mock(**{'order_by.return_value.first.return_value': None})
-    with apply_patches([
-        mocker.patch('awx.conf.models.Setting.objects.filter',
-                     return_value=setting_list),
-        mocker.patch('awx.conf.models.Setting.objects.create', mocker.Mock())
-    ]):
+    with apply_patches(
+        [
+            mocker.patch('awx.conf.models.Setting.objects.filter', return_value=setting_list),
+            mocker.patch('awx.conf.models.Setting.objects.create', mocker.Mock()),
+        ]
+    ):
         settings.AWX_SOME_SETTING = 'NEW-VALUE'
 
-    models.Setting.objects.create.assert_called_with(
-        key='AWX_SOME_SETTING',
-        user=None,
-        value='NEW-VALUE'
-    )
+    models.Setting.objects.create.assert_called_with(key='AWX_SOME_SETTING', user=None, value='NEW-VALUE')
 
 
 def test_db_setting_update(settings, mocker):
     "settings are updated in the database when their value changes"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
 
     existing_setting = mocker.Mock(key='AWX_SOME_SETTING', value='FROM_DB')
-    setting_list = mocker.Mock(**{
-        'order_by.return_value.first.return_value': existing_setting
-    })
+    setting_list = mocker.Mock(**{'order_by.return_value.first.return_value': existing_setting})
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=setting_list):
         settings.AWX_SOME_SETTING = 'NEW-VALUE'
 
@@ -306,12 +211,7 @@ def test_db_setting_update(settings, mocker):
 
 def test_db_setting_deletion(settings, mocker):
     "settings are auto-deleted from the database"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
 
     existing_setting = mocker.Mock(key='AWX_SOME_SETTING', value='FROM_DB')
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=[existing_setting]):
@@ -323,12 +223,7 @@ def test_db_setting_deletion(settings, mocker):
 @pytest.mark.defined_in_file(AWX_SOME_SETTING='DEFAULT')
 def test_read_only_setting_deletion(settings):
     "read-only settings cannot be deleted"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system')
     assert settings.AWX_SOME_SETTING == 'DEFAULT'
     with pytest.raises(ImproperlyConfigured):
         del settings.AWX_SOME_SETTING
@@ -337,36 +232,22 @@ def test_read_only_setting_deletion(settings):
 
 def test_charfield_properly_sets_none(settings, mocker):
     "see: https://github.com/ansible/ansible-tower/issues/5322"
-    settings.registry.register(
-        'AWX_SOME_SETTING',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        allow_null=True
-    )
+    settings.registry.register('AWX_SOME_SETTING', field_class=fields.CharField, category=_('System'), category_slug='system', allow_null=True)
 
     setting_list = mocker.Mock(**{'order_by.return_value.first.return_value': None})
-    with apply_patches([
-        mocker.patch('awx.conf.models.Setting.objects.filter',
-                     return_value=setting_list),
-        mocker.patch('awx.conf.models.Setting.objects.create', mocker.Mock())
-    ]):
+    with apply_patches(
+        [
+            mocker.patch('awx.conf.models.Setting.objects.filter', return_value=setting_list),
+            mocker.patch('awx.conf.models.Setting.objects.create', mocker.Mock()),
+        ]
+    ):
         settings.AWX_SOME_SETTING = None
 
-    models.Setting.objects.create.assert_called_with(
-        key='AWX_SOME_SETTING',
-        user=None,
-        value=None
-    )
+    models.Setting.objects.create.assert_called_with(key='AWX_SOME_SETTING', user=None, value=None)
 
 
 def test_settings_use_cache(settings, mocker):
-    settings.registry.register(
-        'AWX_VAR',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system'
-    )
+    settings.registry.register('AWX_VAR', field_class=fields.CharField, category=_('System'), category_slug='system')
     settings.cache.set('AWX_VAR', 'foobar')
     settings.cache.set('_awx_conf_preload_expires', 100)
     # Will fail test if database is used
@@ -374,13 +255,7 @@ def test_settings_use_cache(settings, mocker):
 
 
 def test_settings_use_an_encrypted_cache(settings, mocker):
-    settings.registry.register(
-        'AWX_ENCRYPTED',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        encrypted=True
-    )
+    settings.registry.register('AWX_ENCRYPTED', field_class=fields.CharField, category=_('System'), category_slug='system', encrypted=True)
     assert isinstance(settings.cache, EncryptedCacheProxy)
     assert settings.cache.__dict__['encrypter'] == encrypt_field
     assert settings.cache.__dict__['decrypter'] == decrypt_field
@@ -393,34 +268,18 @@ def test_settings_use_an_encrypted_cache(settings, mocker):
 
 def test_sensitive_cache_data_is_encrypted(settings, mocker):
     "fields marked as `encrypted` are stored in the cache with encryption"
-    settings.registry.register(
-        'AWX_ENCRYPTED',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        encrypted=True
-    )
+    settings.registry.register('AWX_ENCRYPTED', field_class=fields.CharField, category=_('System'), category_slug='system', encrypted=True)
 
     def rot13(obj, attribute):
         assert obj.pk == 123
         return codecs.encode(getattr(obj, attribute), 'rot_13')
 
     native_cache = LocMemCache(str(uuid4()), {})
-    cache = EncryptedCacheProxy(
-        native_cache,
-        settings.registry,
-        encrypter=rot13,
-        decrypter=rot13
-    )
+    cache = EncryptedCacheProxy(native_cache, settings.registry, encrypter=rot13, decrypter=rot13)
     # Insert the setting value into the database; the encryption process will
     # use its primary key as part of the encryption key
     setting_from_db = mocker.Mock(pk=123, key='AWX_ENCRYPTED', value='SECRET!')
-    mocks = mocker.Mock(**{
-        'order_by.return_value': mocker.Mock(**{
-            '__iter__': lambda self: iter([setting_from_db]),
-            'first.return_value': setting_from_db
-        }),
-    })
+    mocks = mocker.Mock(**{'order_by.return_value': mocker.Mock(**{'__iter__': lambda self: iter([setting_from_db]), 'first.return_value': setting_from_db})})
     with mocker.patch('awx.conf.models.Setting.objects.filter', return_value=mocks):
         cache.set('AWX_ENCRYPTED', 'SECRET!')
         assert cache.get('AWX_ENCRYPTED') == 'SECRET!'
@@ -429,26 +288,14 @@ def test_sensitive_cache_data_is_encrypted(settings, mocker):
 
 def test_readonly_sensitive_cache_data_is_encrypted(settings):
     "readonly fields marked as `encrypted` are stored in the cache with encryption"
-    settings.registry.register(
-        'AWX_ENCRYPTED',
-        field_class=fields.CharField,
-        category=_('System'),
-        category_slug='system',
-        read_only=True,
-        encrypted=True
-    )
+    settings.registry.register('AWX_ENCRYPTED', field_class=fields.CharField, category=_('System'), category_slug='system', read_only=True, encrypted=True)
 
     def rot13(obj, attribute):
         assert obj.pk is None
         return codecs.encode(getattr(obj, attribute), 'rot_13')
 
     native_cache = LocMemCache(str(uuid4()), {})
-    cache = EncryptedCacheProxy(
-        native_cache,
-        settings.registry,
-        encrypter=rot13,
-        decrypter=rot13
-    )
+    cache = EncryptedCacheProxy(native_cache, settings.registry, encrypter=rot13, decrypter=rot13)
     cache.set('AWX_ENCRYPTED', 'SECRET!')
     assert cache.get('AWX_ENCRYPTED') == 'SECRET!'
     assert native_cache.get('AWX_ENCRYPTED') == 'FRPERG!'

awx/conf/urls.py

@@ -3,14 +3,10 @@
 
 
 from django.conf.urls import url
-from awx.conf.views import (
-    SettingCategoryList,
-    SettingSingletonDetail,
-    SettingLoggingTest,
-)
+from awx.conf.views import SettingCategoryList, SettingSingletonDetail, SettingLoggingTest
 
 
-urlpatterns = [ 
+urlpatterns = [
     url(r'^$', SettingCategoryList.as_view(), name='setting_category_list'),
     url(r'^(?P<category_slug>[a-z0-9-]+)/$', SettingSingletonDetail.as_view(), name='setting_singleton_detail'),
     url(r'^logging/test/$', SettingLoggingTest.as_view(), name='setting_logging_test'),

awx/conf/utils.py

@@ -7,7 +7,4 @@ __all__ = ['conf_to_dict']
 
 
 def conf_to_dict(obj):
-    return {
-        'category': settings_registry.get_setting_category(obj.key),
-        'name': obj.key,
-    }
+    return {'category': settings_registry.get_setting_category(obj.key), 'name': obj.key}

awx/conf/views.py

@@ -21,13 +21,8 @@ from rest_framework.response import Response
 from rest_framework import serializers
 from rest_framework import status
 
-# Tower
-from awx.api.generics import (
-    APIView,
-    GenericAPIView,
-    ListAPIView,
-    RetrieveUpdateDestroyAPIView,
-)
+# AWX
+from awx.api.generics import APIView, GenericAPIView, ListAPIView, RetrieveUpdateDestroyAPIView
 from awx.api.permissions import IsSuperUser
 from awx.api.versioning import reverse
 from awx.main.utils import camelcase_to_underscore
@@ -81,9 +76,7 @@ class SettingSingletonDetail(RetrieveUpdateDestroyAPIView):
         if self.category_slug not in category_slugs:
             raise PermissionDenied()
 
-        registered_settings = settings_registry.get_registered_settings(
-            category_slug=self.category_slug, read_only=False,
-        )
+        registered_settings = settings_registry.get_registered_settings(category_slug=self.category_slug, read_only=False)
         if self.category_slug == 'user':
             return Setting.objects.filter(key__in=registered_settings, user=self.request.user)
         else:
@@ -91,9 +84,7 @@ class SettingSingletonDetail(RetrieveUpdateDestroyAPIView):
 
     def get_object(self):
         settings_qs = self.get_queryset()
-        registered_settings = settings_registry.get_registered_settings(
-            category_slug=self.category_slug,
-        )
+        registered_settings = settings_registry.get_registered_settings(category_slug=self.category_slug)
         all_settings = {}
         for setting in settings_qs:
             all_settings[setting.key] = setting.value
@@ -117,9 +108,7 @@ class SettingSingletonDetail(RetrieveUpdateDestroyAPIView):
         for key, value in serializer.validated_data.items():
             if key == 'LICENSE' or settings_registry.is_setting_read_only(key):
                 continue
-            if settings_registry.is_setting_encrypted(key) and \
-                    isinstance(value, str) and \
-                    value.startswith('$encrypted$'):
+            if settings_registry.is_setting_encrypted(key) and isinstance(value, str) and value.startswith('$encrypted$'):
                 continue
             setattr(serializer.instance, key, value)
             setting = settings_qs.filter(key=key).order_by('pk').first()
@@ -133,7 +122,6 @@ class SettingSingletonDetail(RetrieveUpdateDestroyAPIView):
         if settings_change_list:
             connection.on_commit(lambda: handle_setting_changes.delay(settings_change_list))
 
-
     def destroy(self, request, *args, **kwargs):
         instance = self.get_object()
         self.perform_destroy(instance)
@@ -170,7 +158,7 @@ class SettingLoggingTest(GenericAPIView):
         enabled = getattr(settings, 'LOG_AGGREGATOR_ENABLED', False)
         if not enabled:
             return Response({'error': 'Logging not enabled'}, status=status.HTTP_409_CONFLICT)
-        
+
         # Send test message to configured logger based on db settings
         try:
             default_logger = settings.LOG_AGGREGATOR_LOGGERS[0]
@@ -179,18 +167,15 @@ class SettingLoggingTest(GenericAPIView):
         except IndexError:
             default_logger = 'awx'
         logging.getLogger(default_logger).error('AWX Connection Test Message')
-        
+
         hostname = getattr(settings, 'LOG_AGGREGATOR_HOST', None)
         protocol = getattr(settings, 'LOG_AGGREGATOR_PROTOCOL', None)
 
         try:
-            subprocess.check_output(
-                ['rsyslogd', '-N1', '-f', '/var/lib/awx/rsyslog/rsyslog.conf'],
-                stderr=subprocess.STDOUT
-            )
+            subprocess.check_output(['rsyslogd', '-N1', '-f', '/var/lib/awx/rsyslog/rsyslog.conf'], stderr=subprocess.STDOUT)
         except subprocess.CalledProcessError as exc:
             return Response({'error': exc.output}, status=status.HTTP_400_BAD_REQUEST)
-        
+
         # Check to ensure port is open at host
         if protocol in ['udp', 'tcp']:
             port = getattr(settings, 'LOG_AGGREGATOR_PORT', None)
@@ -206,7 +191,7 @@ class SettingLoggingTest(GenericAPIView):
         else:
             s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         try:
-            s.settimeout(.5)
+            s.settimeout(0.5)
             s.connect((hostname, int(port)))
             s.shutdown(SHUT_RDWR)
             s.close()

awx/main/analytics/__init__.py

@@ -1 +1 @@
-from .core import all_collectors, expensive_collectors, register, gather, ship  # noqa
+from .core import all_collectors, register, gather, ship  # noqa

awx/main/analytics/analytics_tasks.py

@@ -0,0 +1,14 @@
+# Python
+import logging
+
+# AWX
+from awx.main.analytics.subsystem_metrics import Metrics
+from awx.main.dispatch.publish import task
+from awx.main.dispatch import get_local_queuename
+
+logger = logging.getLogger('awx.main.scheduler')
+
+
+@task(queue=get_local_queuename)
+def send_subsystem_metrics():
+    Metrics().send_metrics()