Skip to content

Commit 8c64d4a

Browse files
snobearsnobear
committed
reorganize environment for easier building
1 parent f50495a commit 8c64d4a

12 files changed

+367
-401
lines changed

‎.gitignore

+4-2
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,7 @@ coverage.xml
5454
# Sphinx documentation
5555
docs/_build/
5656

57-
# Custom settings file
58-
config.yml
57+
# ezmomi additions
58+
!bin/ezmomi
59+
60+

‎LICENSE

-339
This file was deleted.

‎LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎MANIFEST.in

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include *.txt
2+
include ezmomi/config/config.yml.example

‎bin/ezmomi

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env python
2+
from ezmomi import cli
3+
if __name__ == '__main__':
4+
cli()

‎ezmomi/__init__.py

Whitespace-only changes.

‎ezmomi/cli.py

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import argparse
2+
from params import add_params
3+
4+
5+
'''
6+
Start 'er up
7+
'''
8+
def cli():
9+
# Set up command line arguments
10+
parser = argparse.ArgumentParser(description='Perform common vSphere API tasks')
11+
subparsers = parser.add_subparsers(help='Command', dest='mode')
12+
13+
# set up each command section
14+
add_params(subparsers)
15+
16+
# parse arguments
17+
args = parser.parse_args()
18+
19+
# initialize ezmomi instance
20+
ez = EZMomi(**vars(args))
21+
22+
kwargs = vars(args)
23+
24+
# choose your adventure
25+
if kwargs['mode'] == 'list':
26+
ez.list_objects()
27+
elif kwargs['mode'] == 'clone':
28+
ez.clone()
29+
elif kwargs['mode'] == 'destroy':
30+
ez.destroy()

‎config.yml.example ‎ezmomi/config/config.yml.example

File renamed without changes.

‎ezmomi.py ‎ezmomi/ezmomi.py

+43-36
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,61 @@
1-
#!/usr/bin/env python
21
from pyVim.connect import SmartConnect, Disconnect
32
from pyVmomi import vim, vmodl
43
import atexit
54
import os
65
import sys
6+
import errno
77
from pprint import pprint, pformat
88
import time
99
from netaddr import IPNetwork, IPAddress
10-
import argparse
1110
from copy import deepcopy
1211
import yaml
1312
import logging
1413
from netaddr import IPNetwork, IPAddress
15-
from params import *
1614

1715
'''
1816
Logging
1917
'''
2018
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
2119

22-
2320
class EZMomi(object):
2421
def __init__(self, **kwargs):
2522
# load up our configs and connect to the vSphere server
2623
self.config = self.get_configs(kwargs)
2724
self.connect()
2825

2926
def get_configs(self, kwargs):
27+
default_cfg_dir = "%s/.config/ezmomi" % os.path.expanduser("~")
28+
default_config_path = "%s/config.yml" % default_cfg_dir
29+
30+
# use path from env var if it's set and valid
31+
if 'EZMOMI_CONFIG' in os.environ:
32+
if os.path.isfile(os.environ['EZMOMI_CONFIG']):
33+
config_path = os.environ['EZMOMI_CONFIG']
34+
else:
35+
print "%s does not exist. Set the EZMOMI_CONFIG environment variable to your config file's path."
36+
sys.exit(1)
37+
# or use the default config file path if it exists
38+
elif os.path.isfile(default_config_path):
39+
config_path = default_config_path
40+
# else create the default config path and copy the example config there
41+
else:
42+
from shutil import copy
43+
if not os.path.exists(default_cfg_dir):
44+
os.makedirs(default_cfg_dir)
45+
config_path = default_config_path
46+
47+
#copy()
48+
3049
try:
31-
config_path = '%s/config.yml' % os.path.dirname(os.path.realpath(__file__))
50+
# get config file path from env var or use default
51+
default_cfg_path = default_cfg_dir
52+
config_path = os.environ.get('EZMOMI_CONFIG', default_cfg_path)
3253
config = yaml.load(file(config_path))
3354
except IOError:
34-
logging.exception('Unable to open config file.')
55+
logging.exception('Unable to open config file. The default path for the ezmomi config file is ~/.config/ezmomi/config.yml. You can also specify the config file path by setting the EZMOMI_CONFIG environment variable.')
3556
sys.exit(1)
3657
except Exception:
37-
logging.exception('Unable to read config file.')
58+
logging.exception('Unable to read config file. YAML syntax issue, perhaps?')
3859
sys.exit(1)
3960

4061
# Check all required values were supplied either via command line or config
@@ -221,10 +242,23 @@ def clone(self):
221242
clonespec.template = False
222243

223244
# fire the clone task
224-
task = template_vm.Clone(folder=destfolder, name=self.config['hostname'].title(), spec=clonespec)
245+
task = template_vm.Clone(folder=destfolder, name=self.config['hostname'], spec=clonespec)
225246
result = self.WaitTask(task, 'VM clone task')
226247

227248
self.send_email()
249+
250+
def destroy(self):
251+
print "Finding VM named %s..." % self.config['name']
252+
vm = self.get_obj([vim.VirtualMachine], self.config['name'])
253+
254+
if vm.runtime.powerState == vim.VirtualMachinePowerState.poweredOn:
255+
print "Powering off %s..." % self.config['name']
256+
task = vm.PowerOff()
257+
result = self.WaitTask(task, 'VM power off')
258+
259+
print "Destroying %s..." % self.config['name']
260+
task = vm.Destroy()
261+
result = self.WaitTask(task, 'VM destroy task')
228262

229263
'''
230264
Helper methods
@@ -250,7 +284,6 @@ def send_email(self):
250284
Get the vsphere object associated with a given text name
251285
'''
252286
def get_obj(self, vimtype, name):
253-
vim_obj = "vim.%s" % vimtype
254287
obj = None
255288
container = self.content.viewManager.CreateContainerView(self.content.rootFolder, vimtype, True)
256289
for c in container.view:
@@ -265,7 +298,7 @@ def get_obj(self, vimtype, name):
265298
def WaitTask(self, task, actionName='job', hideResult=False):
266299
while task.info.state == vim.TaskInfo.State.running:
267300
time.sleep(2)
268-
301+
269302
if task.info.state == vim.TaskInfo.State.success:
270303
if task.info.result is not None and not hideResult:
271304
out = '%s completed successfully, result: %s' % (actionName, task.info.result)
@@ -277,29 +310,3 @@ def WaitTask(self, task, actionName='job', hideResult=False):
277310
raise task.info.error
278311

279312
return task.info.result
280-
281-
'''
282-
Ye Olde Main
283-
'''
284-
if __name__ == '__main__':
285-
# Set up command line arguments
286-
parser = argparse.ArgumentParser(description='Perform common vSphere API tasks')
287-
subparsers = parser.add_subparsers(help='Command', dest='mode')
288-
289-
# set up each command section
290-
add_params_for_list(subparsers)
291-
add_params_for_clone(subparsers)
292-
293-
# parse arguments
294-
args = parser.parse_args()
295-
296-
# initialize ezmomi instance
297-
ez = EZMomi(**vars(args))
298-
299-
kwargs = vars(args)
300-
301-
# choose your adventure
302-
if kwargs['mode'] == 'list':
303-
ez.list_objects()
304-
elif kwargs['mode'] == 'clone':
305-
ez.clone()

0 commit comments

Comments
 (0)