summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin.mock/packages/multimethod/package.py
blob: ad58ffd81906a8a5d34fa43bbedb00613be51a56 (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# Copyright 2013-2024 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 spack.platforms
from spack.package import *
from spack.pkg.builtin.mock.multimethod_base import MultimethodBase


class Multimethod(MultimethodBase):
    """This package is designed for use with Spack's multimethod test.
    It has a bunch of test cases for the @when decorator that the
    test uses.
    """

    homepage = "http://www.example.com/"
    url = "http://www.example.com/example-1.0.tar.gz"

    version("5.0", md5="0123456789abcdef0123456789abcdef")
    version("4.0", md5="0123456789abcdef0123456789abcdef")
    version("3.0", md5="0123456789abcdef0123456789abcdef")
    version("2.0", md5="0123456789abcdef0123456789abcdef")
    version("1.0", md5="0123456789abcdef0123456789abcdef")

    variant("mpi", default=False, description="")

    depends_on("mpi", when="+mpi")

    #
    # These functions are only valid for versions 1, 3, and 4.
    #
    @when("@1.0")
    def no_version_2(self):
        return 1

    @when("@3.0")
    def no_version_2(self):
        return 3

    @when("@4.0")
    def no_version_2(self):
        return 4

    #
    # These functions overlap, so there is ambiguity, but we'll take
    # the first one.
    #
    @when("@:4")
    def version_overlap(self):
        return 1

    @when("@2:")
    def version_overlap(self):
        return 2

    #
    # More complicated case with cascading versions.
    #
    def mpi_version(self):
        return 0

    @when("^mpi@3:")
    def mpi_version(self):
        return 3

    @when("^mpi@2:")
    def mpi_version(self):
        return 2

    @when("^mpi@1:")
    def mpi_version(self):
        return 1

    #
    # Use these to test whether the default method is called when no
    # match is found.  This also tests whether we can switch methods
    # on compilers
    #
    def has_a_default(self):
        return "default"

    @when("%gcc")
    def has_a_default(self):
        return "gcc"

    @when("%clang")
    def has_a_default(self):
        return "clang"

    #
    # Make sure we can switch methods on different target
    #
    platform = spack.platforms.host()
    targets = list(platform.targets.values())
    if len(targets) > 1:
        targets = targets[:-1]

    for target in targets:

        @when("target=" + target.name)
        def different_by_target(self):
            if isinstance(self.spec.architecture.target, str):
                return self.spec.architecture.target
            else:
                return self.spec.architecture.target.name

    #
    # Make sure we can switch methods on different dependencies
    #

    @when("^mpich")
    def different_by_dep(self):
        return "mpich"

    @when("^zmpi")
    def different_by_dep(self):
        return "zmpi"

    #
    # Make sure we can switch on virtual dependencies
    #
    def different_by_virtual_dep(self):
        return 1

    @when("^mpi@2:")
    def different_by_virtual_dep(self):
        return 2

    #
    # Make sure methods with a default implementation in a superclass
    # will invoke that method when none in the subclass match.
    #
    @when("@2:")
    def base_method(self):
        return "multimethod"

    #
    # Make sure methods with non-default implementations in a superclass
    # will invoke those methods when none in the subclass match but one in
    # the superclass does.
    #
    @when("@1.0")
    def inherited_and_overridden(self):
        return "base@1.0"

    @when("@2.0")
    def inherited_and_overridden(self):
        return "base@2.0"

    #
    # Make sure that multimethods follow MRO properly with diamond inheritance
    #
    @when("@2.0")
    def diamond_inheritance(self):
        return "first_parent"

    @when("@4.0")
    def diamond_inheritance(self):
        return "should_not_be_reached by diamond inheritance test"

    #
    # Check that multimethods work with boolean values
    #
    @when(True)
    def boolean_true_first(self):
        return "True"

    @when(False)
    def boolean_true_first(self):
        return "False"

    @when(False)
    def boolean_false_first(self):
        return "False"

    @when(True)
    def boolean_false_first(self):
        return "True"