cmd/export: new feature

Creates an updated packages.yaml by augmenting the existing one with
packages installed according to the spec list passed (or all installed
packages by default).

lib/spack/spack/cmd/export.py

@@ -0,0 +1,196 @@
+##############################################################################
+# Copyright (c) 2013-2018, Lawrence Livermore National Security, LLC.
+# Produced at the Lawrence Livermore National Laboratory.
+#
+# This file is part of Spack.
+# Created by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
+# LLNL-CODE-647188
+#
+# For details, see https://github.com/spack/spack
+# Please also see the NOTICE and LICENSE files for our notice and the LGPL.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License (as
+# published by the Free Software Foundation) version 2.1, February 1999.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
+# conditions of the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+##############################################################################
+import os
+import sys
+import ruamel.yaml as yaml
+
+import llnl.util.tty as tty
+import llnl.util.lang
+
+import spack.repo
+import spack.cmd.common.arguments as arguments
+from spack.cmd import display_specs
+
+from spack.build_systems.python import PythonPackage
+
+import spack.util.spack_yaml as syaml
+from spack.util.spack_yaml import syaml_dict, syaml_list
+
+description = "create a package.yaml from installed packages"
+section = "administration"
+level = "long"
+
+
+class PackagesDumper(syaml.OrderedLineDumper):
+    """Customization to match common packages.yaml style
+    """
+
+    def represent_list(self, seq, flow_style=None):
+        """Impose an arbitrary length limit up to flow lists
+        """
+        res = super(PackagesDumper, self).represent_list(seq)
+        tot_len = sum(len(e.value) for e in res.value)
+        res.flow_style = tot_len < 60
+        return res
+
+
+PackagesDumper.add_representer(syaml_list, PackagesDumper.represent_list)
+
+
+def setup_parser(subparser):
+    scopes = spack.config.scopes()
+    subparser.add_argument('-f', '--format',
+                           help="specify format for path/module keys",
+                           metavar="FMT", default='$_$@')
+    subparser.add_argument('-d', '--dependencies',
+                           help="add selected dependencies to the specs",
+                           action='store_true')
+    subparser.add_argument('-m', '--module',
+                           choices=spack.modules.module_types.keys(),
+                           default=None,
+                           help="point to modules generated for MOD",
+                           metavar="MOD")
+    subparser.add_argument("--scope", choices=scopes,
+                           default=spack.config.default_modify_scope(),
+                           help="Configuration scope to modify.")
+    arguments.add_common_arguments(subparser, ['tags', 'constraint'])
+
+
+def export(parser, args):
+    specs = args.specs()
+    # Exit early if no package matches the constraint
+    if not args.specs and args.constraint:
+        msg = "No package matches the query: {0}"
+        msg = msg.format(' '.join(args.constraint))
+        tty.msg(msg)
+        return
+
+    packages = spack.config.get('packages', scope=args.scope)
+
+    # If tags have been specified on the command line, filter by tags
+    if args.tags:
+        packages_with_tags = spack.repo.path.packages_with_tags(*args.tags)
+        specs = [x for x in specs if x.name in packages_with_tags]
+
+    cls = None
+    if args.module:
+        cls = spack.modules.module_types[args.module]
+
+    # Collect packages per package name
+    pkgs = {}
+    for spec in specs:
+        pkgs.setdefault(spec.name, []).append(spec)
+
+    pymods = {}
+
+    # Dump per package, make sure that none are forgotten
+    for pkg, pkg_specs in pkgs.items():
+        paths = syaml_dict()
+        modules = syaml_dict()
+        package = packages.setdefault(pkg, syaml_dict())
+        versions = None
+        if 'version' in package:
+            versions = [str(v) for v in package['version']]
+
+        for spec in pkg_specs:
+            key = spec.format(args.format)
+            sflags = []
+            bflags = []
+            for k, v in spec.variants.items():
+                default = None
+                if k in spec.package.variants:
+                    default = spec.package.variants[k].default
+                if v.value != default:
+                    if v.value in (True, False):
+                        bflags.append(v)
+                    elif v.name != 'patches':
+                        sflags.append(v)
+
+            sflags = ' '.join(str(f) for f in sorted(sflags))
+            bflags = ''.join(str(f) for f in sorted(bflags))
+            key = ' '.join([e for e in (key, sflags, bflags) if len(e) > 0])
+
+            if isinstance(spec.package, PythonPackage):
+                py = spec['python']
+                if args.dependencies:
+                    key += " ^{0}".format(py.format("$_$@"))
+
+                if not spec.package.is_activated(py.package.view()):
+                    # For external packages, setup_environment is not
+                    # called, and thus they are not included in
+                    # PYTHON_PATH.
+                    msg = "python package not activated, skipping: {0}"
+                    msg = msg.format(spec.format("$_$@"))
+                    tty.warn(msg)
+                    # paths[key] = str(spec.prefix)
+                else:
+                    mod = pymods.setdefault(py, cls(py) if cls else None)
+                    if mod and not mod.conf.blacklisted:
+                        if os.path.exists(mod.layout.filename):
+                            paths[key] = '/activated'
+                            # modules[key] = mod.layout.use_name
+                            # paths[key] = str(spec.prefix)
+                    else:
+                        msg = "python package activated in inactive module, skipping: {0}"
+                        msg = msg.format(spec.format("$_$@"))
+                        tty.warn(msg)
+                        continue
+            else:
+                mod = cls(spec) if cls else None
+                if mod and not mod.conf.blacklisted:
+                    if os.path.exists(mod.layout.filename):
+                        modules[key] = mod.layout.use_name
+                    else:
+                        msg = "module not present for {0}"
+                        msg = msg.format(spec.format("$_$@"))
+                        tty.warn(msg)
+                # Even with modules, the path needs to be present to, e.g.,
+                # have `spack setup` work!
+                paths[key] = str(spec.prefix)
+
+            if versions and str(spec.version) not in versions:
+                versions.append(str(spec.version))
+
+        if versions:
+            package['version'] = syaml_list(sorted(versions, reverse=True))
+        if len(paths) > 0:
+            package.setdefault('paths', syaml_dict()).update(paths)
+        if len(modules) > 0:
+            package.setdefault('modules', syaml_dict()).update(modules)
+
+    # Trim empty items from the yaml
+    for cfg in packages.values():
+        for k, v in list(cfg.items()):
+            if (k == 'buildable' and v) or (hasattr(v, '__iter__') and len(v) == 0):
+                del cfg[k]
+
+    # Restore ordering
+    packages = syaml_dict(sorted((k, v) for (k, v) in packages.items() if len(v) > 0))
+    if 'all' in packages:
+        packages['all'] = packages.pop('all')
+    yaml.dump({'packages': packages},
+              stream=sys.stdout,
+              default_flow_style=False,
+              Dumper=PackagesDumper)