Add tests for "spack location" command (#11661)

The "spack location" command was previously untested. This also adds
a check to ensure that composite Stages can report whether they were
expanded (this property was previously only recorded in Stage but not
in CompositeStage).

2 files changed, 135 insertions, 0 deletions

diff --git a/lib/spack/spack/test/cmd/location.py b/lib/spack/spack/test/cmd/location.py
new file mode 100644
index 0000000000..6dbc4d94d4
--- /dev/null
+++ b/lib/spack/spack/test/cmd/location.py
@@ -0,0 +1,131 @@
+# Copyright 2013-2019 Lawrence Livermore National Security, LLC and other
+# Spack Project Developers. See the top-level COPYRIGHT file for details.
+#
+# SPDX-License-Identifier: (Apache-2.0 OR MIT)
+
+import os
+import shutil
+import pytest
+
+from llnl.util.filesystem import mkdirp
+import spack.environment as ev
+from spack.main import SpackCommand, SpackCommandError
+import spack.paths
+
+
+# Everything here uses (or can use) the mock config and database.
+pytestmark = pytest.mark.usefixtures('config', 'database')
+
+# location prints out "locations of packages and spack directories"
+location = SpackCommand('location')
+
+
+@pytest.fixture
+def mock_test_env():
+    test_env_name = 'test'
+    env_dir = ev.root(test_env_name)
+    mkdirp(env_dir)
+    yield test_env_name, env_dir
+
+    # Remove the temporary test environment directory created above
+    shutil.rmtree(env_dir)
+
+
+@pytest.fixture
+def mock_spec():
+    spec = spack.spec.Spec('externaltest').concretized()
+    pkg = spack.repo.get(spec)
+
+    # Make it look like the source was actually expanded.
+    source_path = pkg.stage.source_path
+    mkdirp(source_path)
+    yield spec, pkg
+
+    # Remove the spec from the mock stage area.
+    shutil.rmtree(pkg.stage.path)
+
+
+def test_location_build_dir(mock_spec):
+    """Tests spack location --build-dir."""
+    spec, pkg = mock_spec
+    assert location('--build-dir', spec.name).strip() == pkg.stage.source_path
+
+
+def test_location_build_dir_missing():
+    """Tests spack location --build-dir with a missing build directory."""
+    spec = 'mpileaks'
+    prefix = "==> Error: "
+    expected = "%sBuild directory does not exist yet. Run this to create it:"\
+               "%s  spack stage %s" % (prefix, os.linesep, spec)
+    out = location('--build-dir', spec, fail_on_error=False).strip()
+    assert out == expected
+
+
+@pytest.mark.parametrize('options', [([]),
+                                     (['--build-dir', 'mpileaks']),
+                                     (['--env', 'missing-env']),
+                                     (['spec1', 'spec2'])])
+def test_location_cmd_error(options):
+    """Ensure the proper error is raised with problematic location options."""
+    with pytest.raises(SpackCommandError, match="Command exited with code 1"):
+        location(*options)
+
+
+def test_location_env(mock_test_env):
+    """Tests spack location --env."""
+    test_env_name, env_dir = mock_test_env
+    assert location('--env', test_env_name).strip() == env_dir
+
+
+def test_location_env_missing():
+    """Tests spack location --env."""
+    missing_env_name = 'missing-env'
+    error = "==> Error: no such environment: '%s'" % missing_env_name
+    out = location('--env', missing_env_name, fail_on_error=False).strip()
+    assert out == error
+
+
+@pytest.mark.db
+def test_location_install_dir(mock_spec):
+    """Tests spack location --install-dir."""
+    spec, _ = mock_spec
+    assert location('--install-dir', spec.name).strip() == spec.prefix
+
+
+@pytest.mark.db
+def test_location_package_dir(mock_spec):
+    """Tests spack location --package-dir."""
+    spec, pkg = mock_spec
+    assert location('--package-dir', spec.name).strip() == pkg.package_dir
+
+
+@pytest.mark.db
+@pytest.mark.parametrize('option,expected', [
+    ('--module-dir', spack.paths.module_path),
+    ('--packages', spack.paths.mock_packages_path),
+    ('--spack-root', spack.paths.prefix)])
+def test_location_paths_options(option, expected):
+    """Tests basic spack.paths location command options."""
+    assert location(option).strip() == expected
+
+
+@pytest.mark.parametrize('specs,expected', [
+    ([], "You must supply a spec."),
+    (['spec1', 'spec2'], "Too many specs.  Supply only one.")])
+def test_location_spec_errors(specs, expected):
+    """Tests spack location with bad spec options."""
+    error = "==> Error: %s" % expected
+    assert location(*specs, fail_on_error=False).strip() == error
+
+
+@pytest.mark.db
+def test_location_stage_dir(mock_spec):
+    """Tests spack location --stage-dir."""
+    spec, pkg = mock_spec
+    assert location('--stage-dir', spec.name).strip() == pkg.stage.path
+
+
+@pytest.mark.db
+def test_location_stages(mock_spec):
+    """Tests spack location --stages."""
+    assert location('--stages').strip() == spack.paths.stage_path
diff --git a/lib/spack/spack/test/stage.py b/lib/spack/spack/test/stage.py
index 83d8056119..6b5e698dc3 100644
--- a/lib/spack/spack/test/stage.py
+++ b/lib/spack/spack/test/stage.py
@@ -476,6 +476,8 @@ class TestStage(object):
         composite_stage.create()
         composite_stage.fetch()
         composite_stage.expand_archive()
+        assert composite_stage.expanded  # Archive is expanded
+
         assert os.path.exists(
             os.path.join(composite_stage.source_path, resource_dst_name))
 
@@ -492,6 +494,8 @@ class TestStage(object):
         composite_stage.fetch()
         composite_stage.expand_archive()
 
+        assert composite_stage.expanded  # Archive is expanded
+
         for fname in mock_expand_resource.files:
             file_path = os.path.join(
                 root_stage.source_path, 'resource-dir', fname)