def obtain_path(specs, paths, try_to_generate=False, exit_on_error=True, silent=False):
"""Obtain a path for an easyconfig that matches the given specifications."""
# if no easyconfig files/paths were provided, but we did get a software name,
# we can try and find a suitable easyconfig ourselves, or generate one if we can
(generated, fn) = easyconfig.obtain_ec_for(specs, paths, None)
if not generated:
return (fn, generated)
else:
# if an easyconfig was generated, make sure we're allowed to use it
if try_to_generate:
print_msg("Generated an easyconfig file %s, going to use it now..." % fn, silent=silent)
return (fn, generated)
else:
try:
os.remove(fn)
except OSError, err:
print_warning("Failed to remove generated easyconfig file %s." % fn)
print_error(("Unable to find an easyconfig for the given specifications: %s; "
"to make EasyBuild try to generate a matching easyconfig, "
"use the --try-X options ") % specs, log=log, exit_on_error=exit_on_error)
def runTest(self):
tcname = 'GCC'
tcver = '4.3.2'
patches = ["one.patch"]
# prepare a couple of eb files to test again
fns = ["pi-3.14.eb",
"pi-3.13-GCC-4.3.2.eb",
"pi-3.15-GCC-4.3.2.eb",
"pi-3.15-GCC-4.4.5.eb",
"foo-1.2.3-GCC-4.3.2.eb"]
eb_files = [(fns[0], "\n".join(['name = "pi"',
'version = "3.12"',
'homepage = "http://example.com"',
'description = "test easyconfig"',
'toolchain = {"name": "dummy", "version": "dummy"}',
'patches = %s' % patches
])),
(fns[1], "\n".join(['name = "pi"',
'version = "3.13"',
'homepage = "http://google.com"',
'description = "test easyconfig"',
'toolchain = {"name": "%s", "version": "%s"}' % (tcname, tcver),
'patches = %s' % patches
])),
(fns[2], "\n".join(['name = "pi"',
'version = "3.15"',
'homepage = "http://google.com"',
'description = "test easyconfig"',
'toolchain = {"name": "%s", "version": "%s"}' % (tcname, tcver),
'patches = %s' % patches
])),
(fns[3], "\n".join(['name = "pi"',
'version = "3.15"',
'homepage = "http://google.com"',
'description = "test easyconfig"',
'toolchain = {"name": "%s", "version": "4.5.1"}' % tcname,
'patches = %s' % patches
])),
(fns[4], "\n".join(['name = "foo"',
'version = "1.2.3"',
'homepage = "http://example.com"',
'description = "test easyconfig"',
'toolchain = {"name": "%s", "version": "%s"}' % (tcname, tcver)
]))
]
self.ec_dir = tempfile.mkdtemp()
for (fn, txt) in eb_files:
f = open(os.path.join(self.ec_dir, fn), "w")
f.write(txt)
f.close()
# should crash when no suited easyconfig file (or template) is available
specs = {'name': 'nosuchsoftware'}
error_regexp = ".*No easyconfig files found for software %s, and no templates available. I'm all out of ideas." % specs['name']
self.assertErrorRegex(EasyBuildError, error_regexp, obtain_ec_for, specs, [self.ec_dir], None)
# should find matching easyconfig file
specs = {'name': 'foo', 'version': '1.2.3'}
res = obtain_ec_for(specs, [self.ec_dir], None)
self.assertEqual(res[0], False)
self.assertEqual(res[1], os.path.join(self.ec_dir, fns[-1]))
# should not pick between multiple available toolchain names
name = "pi"
ver = "3.12"
suff = "mysuff"
specs.update({
'name': name,
'version': ver,
'versionsuffix': suff
})
error_regexp = ".*No toolchain name specified, and more than one available: .*"
self.assertErrorRegex(EasyBuildError, error_regexp, obtain_ec_for, specs, [self.ec_dir], None)
# should be able to generate an easyconfig file that slightly differs
ver = '3.16'
specs.update({
'toolchain_name': tcname,
'toolchain_version': tcver,
'version': ver,
'foo': 'bar123'
})
res = obtain_ec_for(specs, [self.ec_dir], None)
self.assertEqual(res[1], "%s-%s-%s-%s%s.eb" % (name, ver, tcname, tcver, suff))
self.assertEqual(res[0], True)
ec = EasyConfig(res[1], valid_stops=self.all_stops)
self.assertEqual(ec['name'], specs['name'])
self.assertEqual(ec['version'], specs['version'])
self.assertEqual(ec['versionsuffix'], specs['versionsuffix'])
self.assertEqual(ec['toolchain'], {'name': tcname, 'version': tcver})
# can't check for key 'foo', because EasyConfig ignores parameter names it doesn't know about
txt = open(res[1], "r").read()
self.assertTrue(re.search('foo = "%s"' % specs['foo'], txt))
os.remove(res[1])
# should pick correct version, i.e. not newer than what's specified, if a choice needs to be made
ver = '3.14'
specs.update({'version': ver})
res = obtain_ec_for(specs, [self.ec_dir], None)
self.assertEqual(res[0], True)
ec = EasyConfig(res[1], valid_stops=self.all_stops)
self.assertEqual(ec['version'], specs['version'])
txt = open(res[1], "r").read()
self.assertTrue(re.search("version = [\"']%s[\"'] .*was: [\"']3.13[\"']" % ver, txt))
os.remove(res[1])
# should pick correct toolchain version as well, i.e. now newer than what's specified, if a choice needs to be made
specs.update({
'version': '3.15',
'toolchain_version': '4.4.5',
})
res = obtain_ec_for(specs, [self.ec_dir], None)
self.assertEqual(res[0], True)
ec = EasyConfig(res[1], valid_stops=self.all_stops)
self.assertEqual(ec['version'], specs['version'])
self.assertEqual(ec['toolchain']['version'], specs['toolchain_version'])
txt = open(res[1], "r").read()
pattern = "toolchain = .*version.*[\"']%s[\"'].*was: .*version.*[\"']%s[\"']" % (specs['toolchain_version'], tcver)
self.assertTrue(re.search(pattern, txt))
os.remove(res[1])
# should be able to prepend to list of patches and handle list of dependencies
extra_patches = ['two.patch', 'three.patch']
deps = [('foo', '1.2.3'), ('bar', '666')]
specs.update({
'patches': extra_patches,
'dependencies': deps
})
res = obtain_ec_for(specs, [self.ec_dir], None)
self.assertEqual(res[0], True)
ec = EasyConfig(res[1], valid_stops=self.all_stops)
self.assertEqual(ec['patches'], specs['patches'] + patches)
self.assertEqual(ec['dependencies'], specs['dependencies'])
os.remove(res[1])
# should use supplied filename
fn = "my.eb"
res = obtain_ec_for(specs, [self.ec_dir], fn)
self.assertEqual(res[0], True)
self.assertEqual(res[1], fn)
os.remove(res[1])
# should use a template if it's there
tpl_path = os.path.join("share", "easybuild", "easyconfigs", "TEMPLATE.eb")
def trim_path(path):
dirs = path.split(os.path.sep)
if len(dirs) > 3 and 'site-packages' in dirs:
if path.endswith('.egg'):
path = os.path.sep.join(dirs[:-4]) # strip of lib/python2.7/site-packages/*.egg part
else:
path = os.path.sep.join(dirs[:-3]) # strip of lib/python2.7/site-packages part
return path
tpl_full_path = find_full_path(tpl_path, trim=trim_path)
# only run this test if the TEMPLATE.eb file is available
# TODO: use unittest.skip for this (but only works from Python 2.7)
if tpl_full_path:
shutil.copy2(tpl_full_path, self.ec_dir)
specs.update({'name': 'nosuchsoftware'})
res = obtain_ec_for(specs, [self.ec_dir], None)
self.assertEqual(res[0], True)
ec = EasyConfig(res[1], valid_stops=self.all_stops)
self.assertEqual(ec['name'], specs['name'])
os.remove(res[1])
