			Path	Packages
M			README.rst (74 lines)
V			{run_testCloud.py → run_testcloud.py}
V			{run_testcloud.py ← run_testCloud.py} (2 lines)
M			setup.py (12 lines)
M			test/test_config.py (2 lines)
M			test/test_image.py (8 lines)
M			test/test_instance.py (2 lines)
V			{testCloud → testcloud}/__init__.py
V			{testCloud → testcloud}/cli.py
V			{testCloud → testcloud}/config.py
V			{testCloud → testcloud}/exceptions.py
V			{testCloud → testcloud}/image.py
V			{testCloud → testcloud}/instance.py
V			{testCloud → testcloud}/util.py
V			{testcloud ← testCloud}/__init__.py
V			{testcloud ← testCloud}/cli.py (14 lines)
V			{testcloud ← testCloud}/config.py (17 lines)
V			{testcloud ← testCloud}/exceptions.py (14 lines)
V			{testcloud ← testCloud}/image.py (12 lines)
V			{testcloud ← testCloud}/instance.py (22 lines)
V			{testcloud ← testCloud}/util.py (4 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	1067	8182242		Jun 19 2015, 11:49 PM	★	★
Diff 2	1068	8182242	Commit rTCLOUDd73d51a43d54a9c75b765e376cafbfc562123ce2	Jun 19 2015, 11:49 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
9e549e577050	a9be253b8d2e	8182242541da	Mike Ruckman	fix: updated readme, renamed everything to testcloud (not testCloud) (Show More…)	Jun 19 2015, 11:20 PM

Diff 1068

View Options

README.rst

1	#########	1	#########
2	testCloud	2	testcloud
3	#########	3	#########
4		4
5	testCloud is a small helper script to download and boot cloud images locally.	5	testcloud is a small helper script to download and boot cloud images locally.
6	Currently only Fedora qcow2 images are tested and supported.	6	Currently only Fedora qcow2 images are tested and supported.
7		7
8	Requirements	8	Requirements
9	------------	9	------------
10		10
11	Packages:	11	Packages:
12	- libvirt	12	- libvirt
13	- libguestfs	13	- libguestfs
14	- libguestfs-tools	14	- libguestfs-tools
15	- python-requests (for whatever python version you're running)	15	- python-requests (for whatever python version you're running)
16		16
17	Optional:	17	Optional:
18	- py.test (if you plan on running or working on the tests)	18	- py.test (if you plan on running or working on the tests)
19		19
20	All of these packages are in the Fedora repos (and likely other distros as	20	All of these packages are in the Fedora repos (and likely other distros as
21	well).	21	well).
22		22
23	For the moment, the follwing directories need to exist with permissions that	23	For the moment, the follwing directories need to exist with permissions that
24	allow modification by any permitted user::	24	allow modification by any permitted user::
25		25
26	/var/lib/testCloud/	26	/var/lib/testcloud/
27	/var/lib/testCloud/instances	27	/var/lib/testcloud/instances
28	/var/lib/testCloud/cache	28	/var/lib/testcloud/cache
29		29
30	This will be automagical in a future version of testCloud and is a side-effect	30	This will be automagical in a future version of testcloud and is a side-effect
31	of the current refactoring/transition process.	31	of the current refactoring/transition process.
32		32
33	If you are running testCloud as a non-administrative user (ie. not in wheel) or	33	If you are running testcloud as a non-administrative user (ie. not in wheel) or
34	on a system that doesn't have a polkit agent running (custom setups, headless	34	on a system that doesn't have a polkit agent running (custom setups, headless
35	systems etc.), you may need to adjust local polkit configuration to allow non-root	35	systems etc.), you may need to adjust local polkit configuration to allow non-root
36	users to manage VMs with libvirt. Add the following data into ``/etc/polkit-1/localauthority/50-local.d/50-nonrootlivirt.pkla``::	36	users to manage VMs with libvirt. Add the following data into ``/etc/polkit-1/localauthority/50-local.d/50-nonrootlivirt.pkla``::
37		37
38	[nonroot libvirt system connection]	38	[nonroot libvirt system connection]
39	Identity=unix-group:testcloud	39	Identity=unix-group:testcloud
40	Action=org.libvirt.unix.manage	40	Action=org.libvirt.unix.manage
41	ResultActive=yes	41	ResultActive=yes
42	ResultInactive=yes	42	ResultInactive=yes
43	ResultAny=yes	43	ResultAny=yes
44		44
45	After writing that file, restart polkit (``systemctl restart polkit``) and if	45	After writing that file, restart polkit (``systemctl restart polkit``) and if
46	the user in question is a member of the unix group ``testcloud``, that user	46	the user in question is a member of the unix group ``testcloud``, that user
47	should be able to run testCloud with no additional permissions.	47	should be able to run testcloud with no additional permissions.
48		48
49	Usage	49	Basic Usage
50	-----	50	-----------
51		51
52	The usage varies slightly between using the git checkout and installing the	52	The usage varies slightly between using the git checkout and installing the
53	module. To run testCloud straight from the git checkout, use	53	module. To run testcloud straight from the git checkout, use
54		54
55	.. code:: bash	55	.. code:: bash
56		56
57	python run_testCloud.py <url for qcow2 image>	57	python run_testCloud.py instance create <instance name> -u <url for qcow2 image>
58		58
59	After installing via pip or setup.py, you can run	59	After installing via pip or setup.py, you can run
60		60
61	.. code:: bash	61	.. code:: bash
62		62
63	testCloud <url for qcow2 image>	63	testcloud instance create <instance name> -u <url for qcow2 image>
		64
		65	This will download the qcow2 and store it in /var/tmp/cache/<qcow2 filename>. This
		66	will be used as a backing store for your instance under /var/tmp/instances/<instance
		67	name>. These instances will be viewable within virt-manager. To see your running
		68	instances run:
		69
		70	.. code:: bash
		71
		72	testcloud instance list
		73
		74	Instances can be stopped, started and destroyed as well through this interface. To
		75	see a list of options, run:
		76
		77	.. code:: bash
		78
		79	testcloud instance -h
		80
		81	Options
		82	-------
64		83
65	There are currently only three options (all optional) you can use when invoking	84	There are currently only three options (all optional) you can use when invoking
66	this script: '--ram', '--no-graphic' and '--atomic'.	85	this script: '--ram', '--no-graphic' and '--atomic'.
67		86
68	The --ram option takes an int for how much ram you want the guest to have, the	87	The --ram option takes an int for how much ram you want the guest to have, the
69	``--no-graphic option`` is merely a flag to suppress a GUI from appearing, the	88	``--no-graphic option`` is merely a flag to suppress a GUI from appearing, the
70	``--atomic`` option indicates that you wish to boot an	89	``--atomic`` option indicates that you wish to boot an
71	`Atomic <http://projectatomic.io>`_ host as well as ``--pristine``, which allows you	90	`Atomic <http://projectatomic.io>`_ host (currently not tested).
72	to reuse a previously downloaded image regardless of whether it's been
73	configured before (reusing an image without ``--pristine`` still boots as
74	expectedi, retaining any configuration done to it previously).
75		91
76	Once the image has booted, you can log in from the GUI or ssh. To log in with	92	Once the image has booted, you can log in from the GUI or ssh. To log in with
77	ssh, run the following command:	93	ssh, run the following command:
78		94
79	.. code:: bash	95	.. code:: bash
80		96
81	ssh -F ./ssh_config testCloud	97	ssh -F ./ssh_config testcloud
82		98
83	The user is 'fedora' and the password is 'passw0rd'	99	The user is 'fedora' and the password is 'passw0rd'
84		100
85	Now you have a working local cloud image to test against.	101	Now you have a working local cloud image to test against.
86		102
87	Configuration	103	Configuration
88	-------------	104	-------------
89		105
90	The default configuration should work for many people but those defaults can	106	The default configuration should work for many people but those defaults can
91	be overridden through the use of a ``settings.py`` file containing the values to	107	be overridden through the use of a ``settings.py`` file containing the values to
92	use when overriding default settings. The example file in	108	use when overriding default settings. The example file in
93	``conf/settings-example.py`` shows the possible configuration values which can	109	``conf/settings-example.py`` shows the possible configuration values which can
94	be changed.	110	be changed.
95		111
96	Note that in order for those new values to be picked up, the filename must be	112	Note that in order for those new values to be picked up, the filename must be
97	``settings.py`` and that file must live in one of the following locations:	113	``settings.py`` and that file must live in one of the following locations:
98		114
99	- ``conf/settings.py`` in the git checkout	115	- ``conf/settings.py`` in the git checkout
100	- ``~/.config/testCloud/settings.py``	116	- ``~/.config/testcloud/settings.py``
101	- ``/etc/testCloud/settings.py``	117	- ``/etc/testcloud/settings.py``
102		118
103	Testing	119	Testing
104	-------	120	-------
105		121
106	Currently there is no testsuite for this script. If it proves useful to someone	122	There is a small testsuite you can run with:
107	else, then we can make one. The best means of ensuring the code works and it's	123
108	not your image, is to test against the latest Fedora Cloud release image. Download	124	.. code:: bash
109	a qcow2 image from `here <http://cloud.fedoraproject.org/>`_.	125
		126	py.test test/
		127
		128	This is a good place to contribute if you're looking to help out.
		129
		130	Issue Tracking and Roadmap
		131	--------------------------
		132
		133	Our project tracker is on the Fedora QA-devel
		134	`Phabricator<https://phab.qadevel.cloud.fedoraproject.org/tag/testcloud/>`_
		135	instance.
110		136
111	Credit	137	Credit
112	------	138	------
113		139
114	Thanks to `Oddshocks <https://github.com/oddshocks>`_ for the koji downloader code :)	140	Thanks to `Oddshocks <https://github.com/oddshocks>`_ for the koji downloader code :)
115		141
116	License	142	License
117	-------	143	-------
118		144
119	This code is licensed GPLv2+. See the LICENSE file for details.	145	This code is licensed GPLv2+. See the LICENSE file for details.

View Options

run_testCloud.py

This file was moved to run_testcloud.py.

View Options

run_testcloud.py

This file was moved from run_testCloud.py.

1	#! /usr/bin/python	1	#! /usr/bin/python
2	from testCloud import cli	2	from testcloud import cli
3		3
4	cli.main()	4	cli.main()

View Options

setup.py

1	from setuptools import setup	1	from setuptools import setup
2		2
3	import testCloud	3	import testcloud
4		4
5		5
6	setup(name='testCloud',	6	setup(name='testcloud',
7	version=testCloud.__version__,	7	version=testcloud.__version__,
8	description="small helper script to download and "	8	description="small helper script to download and "
9	"boot cloud images locally",	9	"boot cloud images locally",
10	author="Mike Ruckman",	10	author="Mike Ruckman",
11	author_email="roshi@fedoraproject.org",	11	author_email="roshi@fedoraproject.org",
12	license="GPLv2+",	12	license="GPLv2+",
13	url="https://github.com/Rorosha/testCloud",	13	url="https://github.com/Rorosha/testCloud",
14	packages=["testCloud"],	14	packages=["testcloud"],
15	package_dir={"testCloud": "testCloud"},	15	package_dir={"testcloud": "testcloud"},
16	include_package_data=True,	16	include_package_data=True,
17	entry_points=dict(console_scripts=["testCloud=testCloud.cli:main"]),	17	entry_points=dict(console_scripts=["testcloud=testcloud.cli:main"]),
18	)	18	)

View Options

test/test_config.py

1	#!/usr/bin/env python	1	#!/usr/bin/env python
2	# -- coding: utf-8 --	2	# -- coding: utf-8 --
3	# Copyright 2015, Red Hat, Inc.	3	# Copyright 2015, Red Hat, Inc.
4	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>	4	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
5	# See the LICENSE file for more details on Licensing	5	# See the LICENSE file for more details on Licensing
6		6
7	from testCloud import config	7	from testcloud import config
8		8
9		9
10	REF_DATA_DIR = "/some/random/dir/for/testing/"	10	REF_DATA_DIR = "/some/random/dir/for/testing/"
11	REF_CACHE_DIR = "/some/random/dir/for/testing/cache/"	11	REF_CACHE_DIR = "/some/random/dir/for/testing/cache/"
12	REF_CONF_CONTENTS = """DATA_DIR = "{}"	12	REF_CONF_CONTENTS = """DATA_DIR = "{}"
13	CACHE_DIR = "{}/cache"	13	CACHE_DIR = "{}/cache"
14	""".format(REF_DATA_DIR, REF_CACHE_DIR)	14	""".format(REF_DATA_DIR, REF_CACHE_DIR)
15		15
▲ Show 20 Lines • Show All 71 Lines • Show Last 20 Lines

View Options

test/test_image.py

1	#!/usr/bin/env python	1		#!/usr/bin/env python
2	# -- coding: utf-8 --	2		# -- coding: utf-8 --
3	# Copyright 2015, Red Hat, Inc.	3		# Copyright 2015, Red Hat, Inc.
4	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>	4		# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
5	# See the LICENSE file for more details on Licensing	5		# See the LICENSE file for more details on Licensing
6		6
7	""" This module is for testing the behaviour of the Image class."""	7		""" This module is for testing the behaviour of the Image class."""
8		8
9	import pytest	9		import pytest
10		10
11	from testCloud import image	11		from testcloud import image
12	from testCloud.exceptions import TestCloudImageError	12		from testcloud.exceptions import TestcloudImageError
13		13
14		14
15	class TestImage:	15		class TestImage:
16		16
17	def test_image_download_path(self):	17		def test_image_download_path(self):
18	pass	18		pass
19		19
20	def test_image_name(self):	20		def test_image_name(self):
▲ Show 20 Lines • Show All 58 Lines • ▼ Show 20 Line(s)		69	def test_file_uri(self):
79	assert test_data['name'] == self.image_name	79		assert test_data['name'] == self.image_name
80	assert test_data['path'] == ref_path	80		assert test_data['path'] == ref_path
81		81
82	def test_invalid_uri_type(self):	82		def test_invalid_uri_type(self):
83	ref_type = 'ftp'	83		ref_type = 'ftp'
84	ref_path = '/localhost/images/{}'.format(self.image_name)	84		ref_path = '/localhost/images/{}'.format(self.image_name)
85	ref_uri = '{}://{}'.format(ref_type, ref_path)	85		ref_uri = '{}://{}'.format(ref_type, ref_path)
86		86
87	with pytest.raises(TestCloudImageError):	87		with pytest.raises(TestcloudImageError):
88	image.Image(ref_uri)	88		image.Image(ref_uri)
89		89
90	def test_invalid_uri(self):	90		def test_invalid_uri(self):
91	ref_uri = 'leprechaunhandywork'	91		ref_uri = 'leprechaunhandywork'
92		92
93	with pytest.raises(TestCloudImageError):	93		with pytest.raises(TestcloudImageError):
94	image.Image(ref_uri)	94		image.Image(ref_uri)

View Options

test/test_instance.py

1	#!/usr/bin/env python	1	#!/usr/bin/env python
2	# -- coding: utf-8 --	2	# -- coding: utf-8 --
3	# Copyright 2015, Red Hat, Inc.	3	# Copyright 2015, Red Hat, Inc.
4	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>	4	# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
5	# See the LICENSE file for more details on Licensing	5	# See the LICENSE file for more details on Licensing
6		6
7	""" This module is for testing the behaviour of the Image class."""	7	""" This module is for testing the behaviour of the Image class."""
8		8
9	import os	9	import os
10		10
11	import mock	11	import mock
12		12
13	from testCloud import instance, image, config	13	from testcloud import instance, image, config
14		14
15		15
16	class TestInstance:	16	class TestInstance:
17		17
18	def test_expand_qcow(self):	18	def test_expand_qcow(self):
19	pass	19	pass
20		20
21	def test_create_seed(self):	21	def test_create_seed(self):
▲ Show 20 Lines • Show All 48 Lines • Show Last 20 Lines