57a6c6a84e
With the implementation of revisioned repository to the CLI in https://review.openstack.org/#/c/577886 there was a change to the lint command [0], which changed it from being a global lint to a site-level (targetted lint)... kind of: Only the CLI logic was modified to support targetted single-site linting. Thus, the first issue this patch set addresses is implementing the back-end logic to realize targetted, single-site linting. The second issue this patch set addresses is re-supporting global linting (linting all sites within a repository) which means that this partially reverts [0] which had (kind of) replaced global linting with per-site linting. So, this patch set: 1) Implements targetted, single-site linting back-end logic 2) Re-implements global linting for all sites in a repo 3) Adds unit tests for both 4) Adds some helper functions to util.engine.definition to help with 1) and 2) [0] https://review.openstack.org/#/c/577886/4/src/bin/pegleg/pegleg/cli.py@191 Change-Id: I5147282556763d93dfaf06912d2c4c876e1bd69f
247 lines
9.2 KiB
Python
247 lines
9.2 KiB
Python
# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import requests
|
|
import shutil
|
|
import tempfile
|
|
|
|
from click.testing import CliRunner
|
|
import mock
|
|
import pytest
|
|
|
|
from pegleg import cli
|
|
from pegleg.engine import errorcodes
|
|
from pegleg.engine.util import git
|
|
|
|
|
|
def is_connected():
|
|
"""Verifies whether network connectivity is up.
|
|
|
|
:returns: True if connected else False.
|
|
"""
|
|
try:
|
|
r = requests.get("http://www.github.com/", proxies={})
|
|
return r.ok
|
|
except requests.exceptions.RequestException:
|
|
return False
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
not is_connected(), reason='git clone requires network connectivity.')
|
|
class BaseCLIActionTest(object):
|
|
@classmethod
|
|
def setup_class(cls):
|
|
cls.runner = CliRunner()
|
|
|
|
# Pin so we know that airship-seaworthy is a valid site.
|
|
cls.site_name = "airship-seaworthy"
|
|
cls.repo_rev = '6b183e148b9bb7ba6f75c98dd13451088255c60b'
|
|
cls.repo_name = "airship-treasuremap"
|
|
repo_url = "https://github.com/openstack/%s.git" % cls.repo_name
|
|
cls.treasuremap_path = git.git_handler(repo_url, ref=cls.repo_rev)
|
|
|
|
@classmethod
|
|
def teardown_class(cls):
|
|
# Cleanup temporary Git repos.
|
|
root_tempdir = tempfile.gettempdir()
|
|
for tempdir in os.listdir(root_tempdir):
|
|
path = os.path.join(root_tempdir, tempdir)
|
|
if git.is_repository(path):
|
|
shutil.rmtree(path, ignore_errors=True)
|
|
|
|
|
|
class TestSiteCliActions(BaseCLIActionTest):
|
|
"""Tests site-level CLI actions."""
|
|
|
|
### Collect tests ###
|
|
|
|
def test_collect_using_remote_repo_url(self):
|
|
"""Validates collect action using a remote URL."""
|
|
# Scenario:
|
|
#
|
|
# 1) Create temporary save location
|
|
# 2) Collect into save location (should clone repo automatically)
|
|
# 3) Check that expected file name is there
|
|
|
|
save_location = tempfile.mkdtemp()
|
|
repo_url = 'https://github.com/openstack/%s@%s' % (self.repo_name,
|
|
self.repo_rev)
|
|
result = self.runner.invoke(
|
|
cli.site,
|
|
['-r', repo_url, 'collect', self.site_name, '-s', save_location])
|
|
|
|
collected_files = os.listdir(save_location)
|
|
|
|
assert result.exit_code == 0
|
|
assert len(collected_files) == 1
|
|
# Validates that site manifests collected from cloned repositories
|
|
# are written out to sensibly named files like airship-treasuremap.yaml
|
|
assert collected_files[0] == ("%s.yaml" % self.repo_name)
|
|
|
|
def test_collect_using_local_path(self):
|
|
"""Validates collect action using a path to a local repo."""
|
|
# Scenario:
|
|
#
|
|
# 1) Create temporary save location
|
|
# 2) Collect into save location (should skip clone repo)
|
|
# 3) Check that expected file name is there
|
|
|
|
save_location = tempfile.mkdtemp()
|
|
repo_path = self.treasuremap_path
|
|
|
|
result = self.runner.invoke(
|
|
cli.site,
|
|
['-r', repo_path, 'collect', self.site_name, '-s', save_location])
|
|
|
|
collected_files = os.listdir(save_location)
|
|
|
|
assert result.exit_code == 0
|
|
assert len(collected_files) == 1
|
|
# Validates that site manifests collected from cloned repositories
|
|
# are written out to sensibly named files like airship-treasuremap.yaml
|
|
assert collected_files[0] == ("%s.yaml" % self.repo_name)
|
|
|
|
### Lint tests ###
|
|
|
|
def test_lint_site_using_remote_repo_url_with_exclude(self):
|
|
"""Validates site lint action using remote repo URL."""
|
|
# Scenario:
|
|
#
|
|
# 1) Mock out Deckhand render (so we can ignore P005 issues)
|
|
# 2) Lint site with exclude flags (should clone repo automatically)
|
|
|
|
repo_url = 'https://github.com/openstack/%s@%s' % (self.repo_name,
|
|
self.repo_rev)
|
|
|
|
lint_command = ['-r', repo_url, 'lint', self.site_name]
|
|
exclude_lint_command = [
|
|
'-x', errorcodes.SCHEMA_STORAGE_POLICY_MISMATCH_FLAG, '-x',
|
|
errorcodes.SECRET_NOT_ENCRYPTED_POLICY
|
|
]
|
|
|
|
with mock.patch('pegleg.engine.site.util.deckhand') as mock_deckhand:
|
|
mock_deckhand.deckhand_render.return_value = ([], [])
|
|
result = self.runner.invoke(cli.site,
|
|
lint_command + exclude_lint_command)
|
|
|
|
assert result.exit_code == 0
|
|
# A successful result (while setting lint checks to exclude) should
|
|
# output nothing.
|
|
assert not result.output
|
|
|
|
def test_lint_site_using_local_path_with_exclude(self):
|
|
"""Validates site lint action using local repo path."""
|
|
# Scenario:
|
|
#
|
|
# 1) Mock out Deckhand render (so we can ignore P005 issues)
|
|
# 2) Lint site with exclude flags (should skip clone repo)
|
|
|
|
repo_path = self.treasuremap_path
|
|
lint_command = ['-r', repo_path, 'lint', self.site_name]
|
|
exclude_lint_command = [
|
|
'-x', errorcodes.SCHEMA_STORAGE_POLICY_MISMATCH_FLAG, '-x',
|
|
errorcodes.SECRET_NOT_ENCRYPTED_POLICY
|
|
]
|
|
|
|
with mock.patch('pegleg.engine.site.util.deckhand') as mock_deckhand:
|
|
mock_deckhand.deckhand_render.return_value = ([], [])
|
|
result = self.runner.invoke(cli.site,
|
|
lint_command + exclude_lint_command)
|
|
|
|
assert result.exit_code == 0
|
|
# A successful result (while setting lint checks to exclude) should
|
|
# output nothing.
|
|
assert not result.output
|
|
|
|
def test_lint_site_using_local_path_with_warn(self):
|
|
"""Validates site lint action using local repo path."""
|
|
# Scenario:
|
|
#
|
|
# 1) Mock out Deckhand render (so we can ignore P005 issues)
|
|
# 2) Lint site with warn flags (should skip clone repo)
|
|
|
|
repo_path = self.treasuremap_path
|
|
lint_command = ['-r', repo_path, 'lint', self.site_name]
|
|
warn_lint_command = [
|
|
'-w', errorcodes.SCHEMA_STORAGE_POLICY_MISMATCH_FLAG, '-w',
|
|
errorcodes.SECRET_NOT_ENCRYPTED_POLICY
|
|
]
|
|
|
|
with mock.patch('pegleg.engine.site.util.deckhand') as mock_deckhand:
|
|
mock_deckhand.deckhand_render.return_value = ([], [])
|
|
result = self.runner.invoke(cli.site,
|
|
lint_command + warn_lint_command)
|
|
|
|
assert result.exit_code == 0
|
|
# A successful result (while setting lint checks to warns) should
|
|
# output warnings.
|
|
assert result.output
|
|
|
|
|
|
class TestRepoCliActions(BaseCLIActionTest):
|
|
"""Tests repo-level CLI actions."""
|
|
|
|
### Lint tests ###
|
|
|
|
def test_lint_repo_using_remote_repo_url_with_exclude(self):
|
|
"""Validates repo lint action using remote repo URL."""
|
|
# Scenario:
|
|
#
|
|
# 1) Mock out Deckhand render (so we can ignore P005 issues)
|
|
# 2) Lint repo with exclude flags (should clone repo automatically)
|
|
|
|
repo_url = 'https://github.com/openstack/%s@%s' % (self.repo_name,
|
|
self.repo_rev)
|
|
|
|
lint_command = ['-r', repo_url, 'lint']
|
|
exclude_lint_command = [
|
|
'-x', errorcodes.SCHEMA_STORAGE_POLICY_MISMATCH_FLAG, '-x',
|
|
errorcodes.SECRET_NOT_ENCRYPTED_POLICY
|
|
]
|
|
|
|
with mock.patch('pegleg.engine.site.util.deckhand') as mock_deckhand:
|
|
mock_deckhand.deckhand_render.return_value = ([], [])
|
|
result = self.runner.invoke(cli.repo,
|
|
lint_command + exclude_lint_command)
|
|
|
|
assert result.exit_code == 0
|
|
# A successful result (while setting lint checks to exclude) should
|
|
# output nothing.
|
|
assert not result.output
|
|
|
|
def test_lint_repo_using_local_path_with_exclude(self):
|
|
"""Validates repo lint action using local repo path."""
|
|
# Scenario:
|
|
#
|
|
# 1) Mock out Deckhand render (so we can ignore P005 issues)
|
|
# 2) Lint repo with exclude flags (should skip clone repo)
|
|
|
|
repo_path = self.treasuremap_path
|
|
lint_command = ['-r', repo_path, 'lint']
|
|
exclude_lint_command = [
|
|
'-x', errorcodes.SCHEMA_STORAGE_POLICY_MISMATCH_FLAG, '-x',
|
|
errorcodes.SECRET_NOT_ENCRYPTED_POLICY
|
|
]
|
|
|
|
with mock.patch('pegleg.engine.site.util.deckhand') as mock_deckhand:
|
|
mock_deckhand.deckhand_render.return_value = ([], [])
|
|
result = self.runner.invoke(cli.repo,
|
|
lint_command + exclude_lint_command)
|
|
|
|
assert result.exit_code == 0
|
|
# A successful result (while setting lint checks to exclude) should
|
|
# output nothing.
|
|
assert not result.output
|