Reorganize tests/cmd
This commit reorganizes the 'cmd' tests by subcommand. Previously the multipath test was using an actual fixture directory which actually made the fixtures directory somewhat unusable by other tests since with an upcoming change (get_plugins_version) fixtures directories may also contain YAML that doesn't contain JJB data. Change-Id: I4c3866e1e0769512b40e1790e40affedb13953a2
This commit is contained in:
Wayne
parent
ff7b93c8ef
commit
288af951b5
@ -1,10 +0,0 @@
|
||||
# this file is here to ensure the directory containing it is caught by git for
|
||||
# the sake of multipath testing.
|
||||
- job-template:
|
||||
name: 'herp-job'
|
||||
description: 'a simple job'
|
||||
|
||||
- project:
|
||||
name: herp-project
|
||||
jobs:
|
||||
- herp-job
|
||||
0
tests/cmd/subcommands/__init__.py
Normal file
0
tests/cmd/subcommands/__init__.py
Normal file
45
tests/cmd/subcommands/test_delete.py
Normal file
45
tests/cmd/subcommands/test_delete.py
Normal file
@ -0,0 +1,45 @@
|
||||
import os
|
||||
import mock
|
||||
from jenkins_jobs import cmd
|
||||
from tests.cmd.test_cmd import CmdTestsBase
|
||||
|
||||
|
||||
class DeleteTests(CmdTestsBase):
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.delete_job')
|
||||
def test_delete_single_job(self, delete_job_mock):
|
||||
"""
|
||||
Test handling the deletion of a single Jenkins job.
|
||||
"""
|
||||
|
||||
args = self.parser.parse_args(['delete', 'test_job'])
|
||||
cmd.execute(args, self.config) # passes if executed without error
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.delete_job')
|
||||
def test_delete_multiple_jobs(self, delete_job_mock):
|
||||
"""
|
||||
Test handling the deletion of multiple Jenkins jobs.
|
||||
"""
|
||||
|
||||
args = self.parser.parse_args(['delete', 'test_job1', 'test_job2'])
|
||||
cmd.execute(args, self.config) # passes if executed without error
|
||||
|
||||
@mock.patch('jenkins_jobs.builder.Jenkins.delete_job')
|
||||
def test_delete_using_glob_params(self, delete_job_mock):
|
||||
"""
|
||||
Test handling the deletion of multiple Jenkins jobs using the glob
|
||||
parameters feature.
|
||||
"""
|
||||
|
||||
args = self.parser.parse_args(['delete',
|
||||
'--path',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-002.yaml'),
|
||||
'*bar*'])
|
||||
cmd.execute(args, self.config)
|
||||
calls = [mock.call('bar001'), mock.call('bar002')]
|
||||
delete_job_mock.assert_has_calls(calls, any_order=True)
|
||||
self.assertEquals(delete_job_mock.call_count, len(calls),
|
||||
"Jenkins.delete_job() was called '%s' times when "
|
||||
"expected '%s'" % (delete_job_mock.call_count,
|
||||
len(calls)))
|
||||
156
tests/cmd/subcommands/test_test.py
Normal file
156
tests/cmd/subcommands/test_test.py
Normal file
@ -0,0 +1,156 @@
|
||||
import os
|
||||
import io
|
||||
import codecs
|
||||
import mock
|
||||
from jenkins_jobs import cmd
|
||||
from tests.cmd.test_cmd import CmdTestsBase
|
||||
|
||||
|
||||
os_walk_return_values = {
|
||||
'/jjb_projects': [
|
||||
('/jjb_projects', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_projects/dir1', ('bar',), ()),
|
||||
('/jjb_projects/dir2', ('baz',), ()),
|
||||
('/jjb_projects/dir3', (), ()),
|
||||
('/jjb_projects/dir1/bar', (), ()),
|
||||
('/jjb_projects/dir2/baz', (), ()),
|
||||
],
|
||||
'/jjb_templates': [
|
||||
('/jjb_templates', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_templates/dir1', ('bar',), ()),
|
||||
('/jjb_templates/dir2', ('baz',), ()),
|
||||
('/jjb_templates/dir3', (), ()),
|
||||
('/jjb_templates/dir1/bar', (), ()),
|
||||
('/jjb_templates/dir2/baz', (), ()),
|
||||
],
|
||||
'/jjb_macros': [
|
||||
('/jjb_macros', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_macros/dir1', ('bar',), ()),
|
||||
('/jjb_macros/dir2', ('baz',), ()),
|
||||
('/jjb_macros/dir3', (), ()),
|
||||
('/jjb_macros/dir1/bar', (), ()),
|
||||
('/jjb_macros/dir2/baz', (), ()),
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
def os_walk_side_effects(path_name, topdown):
|
||||
return os_walk_return_values[path_name]
|
||||
|
||||
|
||||
class TestTests(CmdTestsBase):
|
||||
|
||||
def test_non_existing_config_dir(self):
|
||||
"""
|
||||
Run test mode and pass a non-existing configuration directory
|
||||
"""
|
||||
args = self.parser.parse_args(['test', 'foo'])
|
||||
self.assertRaises(IOError, cmd.execute, args, self.config)
|
||||
|
||||
def test_non_existing_config_file(self):
|
||||
"""
|
||||
Run test mode and pass a non-existing configuration file
|
||||
"""
|
||||
args = self.parser.parse_args(['test', 'non-existing.yaml'])
|
||||
self.assertRaises(IOError, cmd.execute, args, self.config)
|
||||
|
||||
def test_non_existing_job(self):
|
||||
"""
|
||||
Run test mode and pass a non-existing job name
|
||||
(probably better to fail here)
|
||||
"""
|
||||
args = self.parser.parse_args(['test',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml'),
|
||||
'invalid'])
|
||||
args.output_dir = mock.MagicMock()
|
||||
cmd.execute(args, self.config) # probably better to fail here
|
||||
|
||||
def test_valid_job(self):
|
||||
"""
|
||||
Run test mode and pass a valid job name
|
||||
"""
|
||||
args = self.parser.parse_args(['test',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml'),
|
||||
'foo-job'])
|
||||
args.output_dir = mock.MagicMock()
|
||||
cmd.execute(args, self.config) # probably better to fail here
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.update_job')
|
||||
def test_multi_path(self, update_job_mock):
|
||||
"""
|
||||
Run test mode and pass multiple paths.
|
||||
"""
|
||||
path_list = list(os_walk_return_values.keys())
|
||||
multipath = os.pathsep.join(path_list)
|
||||
|
||||
args = self.parser.parse_args(['test', multipath])
|
||||
args.output_dir = mock.MagicMock()
|
||||
|
||||
cmd.execute(args, self.config)
|
||||
self.assertEqual(args.path, path_list)
|
||||
update_job_mock.assert_called_with(path_list, [],
|
||||
output=args.output_dir)
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.update_job')
|
||||
@mock.patch('jenkins_jobs.cmd.os.path.isdir')
|
||||
@mock.patch('jenkins_jobs.cmd.os.walk')
|
||||
def test_recursive_multi_path(self, os_walk_mock, isdir_mock,
|
||||
update_job_mock):
|
||||
"""
|
||||
Run test mode and pass multiple paths with recursive path option.
|
||||
"""
|
||||
|
||||
os_walk_mock.side_effect = os_walk_side_effects
|
||||
isdir_mock.return_value = True
|
||||
|
||||
path_list = os_walk_return_values.keys()
|
||||
paths = []
|
||||
for path in path_list:
|
||||
paths.extend([p for p, _, _ in
|
||||
os_walk_return_values[path]])
|
||||
|
||||
multipath = os.pathsep.join(path_list)
|
||||
|
||||
args = self.parser.parse_args(['test', '-r', multipath])
|
||||
args.output_dir = mock.MagicMock()
|
||||
|
||||
cmd.execute(args, self.config)
|
||||
|
||||
update_job_mock.assert_called_with(paths, [], output=args.output_dir)
|
||||
|
||||
args = self.parser.parse_args(['test', multipath])
|
||||
self.config.set('job_builder', 'recursive', 'True')
|
||||
cmd.execute(args, self.config)
|
||||
|
||||
update_job_mock.assert_called_with(paths, [], output=args.output_dir)
|
||||
|
||||
def test_console_output(self):
|
||||
"""
|
||||
Run test mode and verify that resulting XML gets sent to the console.
|
||||
"""
|
||||
|
||||
console_out = io.BytesIO()
|
||||
with mock.patch('sys.stdout', console_out):
|
||||
cmd.main(['test', os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml')])
|
||||
xml_content = codecs.open(os.path.join(self.fixtures_path,
|
||||
'cmd-001.xml'),
|
||||
'r', 'utf-8').read()
|
||||
self.assertEqual(console_out.getvalue().decode('utf-8'), xml_content)
|
||||
|
||||
def test_config_with_test(self):
|
||||
"""
|
||||
Run test mode and pass a config file
|
||||
"""
|
||||
args = self.parser.parse_args(['--conf',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.conf'),
|
||||
'test',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml'),
|
||||
'foo-job'])
|
||||
config = cmd.setup_config_settings(args)
|
||||
self.assertEqual(config.get('jenkins', 'url'),
|
||||
"http://test-jenkins.with.non.default.url:8080/")
|
||||
@ -1,30 +1,36 @@
|
||||
import os
|
||||
from six.moves import configparser, StringIO
|
||||
import io
|
||||
import codecs
|
||||
import mock
|
||||
import testtools
|
||||
from jenkins_jobs import cmd
|
||||
|
||||
|
||||
# Testing the cmd module can sometimes result in the CacheStorage class
|
||||
# attempting to create the cache directory multiple times as the tests
|
||||
# are run in parallel. Stub out the CacheStorage to ensure that each
|
||||
# test can safely create the cache directory without risk of interference.
|
||||
class CmdTests(testtools.TestCase):
|
||||
class CmdTestsBase(testtools.TestCase):
|
||||
|
||||
fixtures_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
parser = cmd.create_parser()
|
||||
|
||||
def setUp(self):
|
||||
super(CmdTests, self).setUp()
|
||||
super(CmdTestsBase, self).setUp()
|
||||
|
||||
# Testing the cmd module can sometimes result in the CacheStorage class
|
||||
# attempting to create the cache directory multiple times as the tests
|
||||
# are run in parallel. Stub out the CacheStorage to ensure that each
|
||||
# test can safely create the cache directory without risk of
|
||||
# interference.
|
||||
self.cache_patch = mock.patch('jenkins_jobs.builder.CacheStorage',
|
||||
autospec=True)
|
||||
self.cache_patch.start()
|
||||
|
||||
self.config = configparser.ConfigParser()
|
||||
self.config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
|
||||
def tearDown(self):
|
||||
self.cache_patch.stop()
|
||||
super(CmdTests, self).tearDown()
|
||||
super(CmdTestsBase, self).tearDown()
|
||||
|
||||
|
||||
class CmdTests(CmdTestsBase):
|
||||
|
||||
def test_with_empty_args(self):
|
||||
"""
|
||||
@ -32,232 +38,3 @@ class CmdTests(testtools.TestCase):
|
||||
"""
|
||||
with mock.patch('sys.stderr'):
|
||||
self.assertRaises(SystemExit, cmd.main, [])
|
||||
|
||||
def test_non_existing_config_dir(self):
|
||||
"""
|
||||
Run test mode and pass a non-existing configuration directory
|
||||
"""
|
||||
args = self.parser.parse_args(['test', 'foo'])
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
self.assertRaises(IOError, cmd.execute, args, config)
|
||||
|
||||
def test_non_existing_config_file(self):
|
||||
"""
|
||||
Run test mode and pass a non-existing configuration file
|
||||
"""
|
||||
args = self.parser.parse_args(['test', 'non-existing.yaml'])
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
self.assertRaises(IOError, cmd.execute, args, config)
|
||||
|
||||
def test_non_existing_job(self):
|
||||
"""
|
||||
Run test mode and pass a non-existing job name
|
||||
(probably better to fail here)
|
||||
"""
|
||||
args = self.parser.parse_args(['test',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml'),
|
||||
'invalid'])
|
||||
args.output_dir = mock.MagicMock()
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config) # probably better to fail here
|
||||
|
||||
def test_valid_job(self):
|
||||
"""
|
||||
Run test mode and pass a valid job name
|
||||
"""
|
||||
args = self.parser.parse_args(['test',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml'),
|
||||
'foo-job'])
|
||||
args.output_dir = mock.MagicMock()
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config) # probably better to fail here
|
||||
|
||||
def test_multi_path(self):
|
||||
"""
|
||||
Run test mode and pass multiple paths.
|
||||
"""
|
||||
path_list = [os.path.join(self.fixtures_path, 'multipath'),
|
||||
self.fixtures_path]
|
||||
multipath = os.pathsep.join(path_list)
|
||||
args = self.parser.parse_args(['test', multipath])
|
||||
args.output_dir = mock.MagicMock()
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config)
|
||||
self.assertEqual(args.path, path_list)
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.update_job')
|
||||
@mock.patch('jenkins_jobs.cmd.os.path.isdir')
|
||||
@mock.patch('jenkins_jobs.cmd.os.walk')
|
||||
def test_recursive_multi_path(self, os_walk_mock, isdir_mock,
|
||||
update_job_mock):
|
||||
"""
|
||||
Run test mode and pass multiple paths with recursive path option.
|
||||
"""
|
||||
os_walk_return_values = {
|
||||
'/jjb_projects': [
|
||||
('/jjb_projects', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_projects/dir1', ('bar',), ()),
|
||||
('/jjb_projects/dir2', ('baz',), ()),
|
||||
('/jjb_projects/dir3', (), ()),
|
||||
('/jjb_projects/dir1/bar', (), ()),
|
||||
('/jjb_projects/dir2/baz', (), ()),
|
||||
],
|
||||
'/jjb_templates': [
|
||||
('/jjb_templates', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_templates/dir1', ('bar',), ()),
|
||||
('/jjb_templates/dir2', ('baz',), ()),
|
||||
('/jjb_templates/dir3', (), ()),
|
||||
('/jjb_templates/dir1/bar', (), ()),
|
||||
('/jjb_templates/dir2/baz', (), ()),
|
||||
],
|
||||
'/jjb_macros': [
|
||||
('/jjb_macros', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_macros/dir1', ('bar',), ()),
|
||||
('/jjb_macros/dir2', ('baz',), ()),
|
||||
('/jjb_macros/dir3', (), ()),
|
||||
('/jjb_macros/dir1/bar', (), ()),
|
||||
('/jjb_macros/dir2/baz', (), ()),
|
||||
],
|
||||
}
|
||||
|
||||
def os_walk_side_effects(path_name, topdown):
|
||||
return os_walk_return_values[path_name]
|
||||
|
||||
os_walk_mock.side_effect = os_walk_side_effects
|
||||
isdir_mock.return_value = True
|
||||
|
||||
path_list = os_walk_return_values.keys()
|
||||
paths = []
|
||||
for path in path_list:
|
||||
paths.extend([p for p, _, _ in os_walk_return_values[path]])
|
||||
|
||||
multipath = os.pathsep.join(path_list)
|
||||
|
||||
args = self.parser.parse_args(['test', '-r', multipath])
|
||||
args.output_dir = mock.MagicMock()
|
||||
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config)
|
||||
|
||||
update_job_mock.assert_called_with(paths, [], output=args.output_dir)
|
||||
|
||||
args = self.parser.parse_args(['test', multipath])
|
||||
config.set('job_builder', 'recursive', 'True')
|
||||
cmd.execute(args, config)
|
||||
|
||||
update_job_mock.assert_called_with(paths, [], output=args.output_dir)
|
||||
|
||||
def test_console_output(self):
|
||||
"""
|
||||
Run test mode and verify that resulting XML gets sent to the console.
|
||||
"""
|
||||
|
||||
console_out = io.BytesIO()
|
||||
with mock.patch('sys.stdout', console_out):
|
||||
cmd.main(['test', os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml')])
|
||||
xml_content = codecs.open(os.path.join(self.fixtures_path,
|
||||
'cmd-001.xml'),
|
||||
'r', 'utf-8').read()
|
||||
self.assertEqual(console_out.getvalue().decode('utf-8'), xml_content)
|
||||
|
||||
def test_config_with_test(self):
|
||||
"""
|
||||
Run test mode and pass a config file
|
||||
"""
|
||||
args = self.parser.parse_args(['--conf',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.conf'),
|
||||
'test',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-001.yaml'),
|
||||
'foo-job'])
|
||||
config = cmd.setup_config_settings(args)
|
||||
self.assertEqual(config.get('jenkins', 'url'),
|
||||
"http://test-jenkins.with.non.default.url:8080/")
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.update_job')
|
||||
@mock.patch('jenkins_jobs.cmd.os.path.isdir')
|
||||
@mock.patch('jenkins_jobs.cmd.os.walk')
|
||||
def test_recursive_path_option(self, os_walk_mock, isdir_mock,
|
||||
update_job_mock):
|
||||
"""
|
||||
Test handling of recursive path option
|
||||
"""
|
||||
|
||||
os_walk_mock.return_value = [
|
||||
('/jjb_configs', ('dir1', 'dir2', 'dir3'), ()),
|
||||
('/jjb_configs/dir1', ('bar',), ()),
|
||||
('/jjb_configs/dir2', ('baz',), ()),
|
||||
('/jjb_configs/dir3', (), ()),
|
||||
('/jjb_configs/dir1/bar', (), ()),
|
||||
('/jjb_configs/dir2/baz', (), ()),
|
||||
]
|
||||
isdir_mock.return_value = True
|
||||
paths = [path for path, _, _ in os_walk_mock.return_value]
|
||||
|
||||
args = self.parser.parse_args(['test', '-r', '/jjb_configs'])
|
||||
args.output_dir = mock.MagicMock()
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config) # probably better to fail here
|
||||
|
||||
update_job_mock.assert_called_with(paths, [], output=args.output_dir)
|
||||
|
||||
args = self.parser.parse_args(['test', '/jjb_configs'])
|
||||
config.set('job_builder', 'recursive', 'True')
|
||||
cmd.execute(args, config) # probably better to fail here
|
||||
|
||||
update_job_mock.assert_called_with(paths, [], output=args.output_dir)
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.delete_job')
|
||||
def test_delete_single_job(self, delete_job_mock):
|
||||
"""
|
||||
Test handling the deletion of a single Jenkins job.
|
||||
"""
|
||||
|
||||
args = self.parser.parse_args(['delete', 'test_job'])
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config) # passes if executed without error
|
||||
|
||||
@mock.patch('jenkins_jobs.cmd.Builder.delete_job')
|
||||
def test_delete_multiple_jobs(self, delete_job_mock):
|
||||
"""
|
||||
Test handling the deletion of multiple Jenkins jobs.
|
||||
"""
|
||||
|
||||
args = self.parser.parse_args(['delete', 'test_job1', 'test_job2'])
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config) # passes if executed without error
|
||||
|
||||
@mock.patch('jenkins_jobs.builder.Jenkins.delete_job')
|
||||
def test_delete_using_glob_params(self, delete_job_mock):
|
||||
"""
|
||||
Test handling the deletion of multiple Jenkins jobs using the glob
|
||||
parameters feature.
|
||||
"""
|
||||
|
||||
args = self.parser.parse_args(['delete',
|
||||
'--path',
|
||||
os.path.join(self.fixtures_path,
|
||||
'cmd-002.yaml'),
|
||||
'*bar*'])
|
||||
config = configparser.ConfigParser()
|
||||
config.readfp(StringIO(cmd.DEFAULT_CONF))
|
||||
cmd.execute(args, config)
|
||||
calls = [mock.call('bar001'), mock.call('bar002')]
|
||||
delete_job_mock.assert_has_calls(calls, any_order=True)
|
||||
self.assertEquals(delete_job_mock.call_count, len(calls),
|
||||
"Jenkins.delete_job() was called '%s' times when "
|
||||
"expected '%s'" % (delete_job_mock.call_count,
|
||||
len(calls)))
|
||||
|
||||
Loading…
Reference in New Issue
Block a user