summaryrefslogtreecommitdiff
path: root/lib/spack/spack/test/cmd/location.py
blob: 3977cba3e5ff301d1aa08090c4d20adcefa25f8a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# Copyright 2013-2020 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
import spack.stage


# 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.stage.get_stage_root()