summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/pfunit/package.py
blob: 43fee416361a31a19bf31bba56eb31861e54c1fc (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
# Copyright 2013-2022 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 glob

from spack.package import *


class Pfunit(CMakePackage):
    """pFUnit is a unit testing framework enabling JUnit-like testing of
    serial and MPI-parallel software written in Fortran."""

    homepage = "http://pfunit.sourceforge.net/"
    url = "https://github.com/Goddard-Fortran-Ecosystem/pFUnit/releases/download/v4.1.10/pFUnit-4.1.10.tar"

    maintainers = ["citibeth"]

    version("4.1.14", sha256="bada2be8d7e69ca1f16209ba92293fa1c06748b78534d71b24b2c825450a495f")
    version("4.1.13", sha256="f388e08c67c51cbfd9f3a3658baac912b5506d2fc651410cd34a21260c309630")
    version("4.1.12", sha256="7d71b0fb996497fe9a20eb818d02d596cd0d3cded1033a89a9081fbd925c68f2")
    version("4.1.11", sha256="16160bac223aaa3ed2b27e30287d25fdaec3cf6f2c570ebd8d61196e6aa6180f")
    version("4.1.10", sha256="051c35ad9678002943f4a4f2ab532a6b44de86ca414751616f93e69f393f5373")
    version("3.3.3", sha256="9f673b58d20ad23148040a100227b4f876458a9d9aee0f0d84a5f0eef209ced5")
    version("3.3.2", sha256="b1cc2e109ba602ea71bccefaa3c4a06e7ab1330db9ce6c08db89cfde497b8ab8")
    version("3.3.1", sha256="f8f4bea7de991a518a0371b4c70b19e492aa9a0d3e6715eff9437f420b0cdb45")
    version("3.3.0", sha256="4036ab448b821b500fbe8be5e3d5ab3e419ebae8be82f7703bcf84ab1a0ff862")
    version("3.2.10", sha256="b9debba6d0e31b682423ffa756531e9728c10acde08c4d8e1609b4554f552b1a")
    version("3.2.9", sha256="403f9a150865700c8b4240fd033162b8d3e8aeefa265c50c5a6fe14c455fbabc")

    variant("shared", default=True, description="Build shared library in addition to static")
    variant("mpi", default=False, description="Enable MPI")
    variant("use_comm_world", default=False, description="Enable MPI_COMM_WORLD for testing")
    variant("openmp", default=False, description="Enable OpenMP")
    variant("docs", default=False, description="Build docs")

    variant(
        "max_array_rank",
        values=int,
        default=5,
        description="Max number of Fortran dimensions of array asserts",
    )

    depends_on("python@2.7:", type=("build", "run"))  # python3 too!
    depends_on("mpi", when="+mpi")
    depends_on("m4", when="@4.1.5:", type="build")

    conflicts(
        "%gcc@:8.3.9",
        when="@4.0.0:",
        msg="Older versions of GCC do "
        "not support the Fortran 2008 features required by new pFUnit.",
    )
    # See https://github.com/Goddard-Fortran-Ecosystem/pFUnit/pull/179
    conflicts("+shared", when="@4.0.0:")
    conflicts("+use_comm_world", when="~mpi")
    patch("mpi-test.patch", when="@:3 +use_comm_world")

    def patch(self):
        # The package tries to put .mod files in directory ./mod;
        # spack needs to put them in a standard location:
        for file in glob.glob("*/CMakeLists.txt"):
            filter_file(r".*/mod($|[^\w].*)", "", file)

    def url_for_version(self, version):
        # Version 4 uses a different URL syntax than previous versions
        url_base = "https://github.com/Goddard-Fortran-Ecosystem/pFUnit"
        if version >= Version("4"):
            url = url_base + "/releases/download/v{0}/pFUnit-{0}.tar"
        else:
            url = url_base + "/archive/{0}.tar.gz"

        return url.format(version.dotted)

    def cmake_args(self):
        spec = self.spec
        args = [
            "-DPYTHON_EXECUTABLE=%s" % spec["python"].command,
            self.define_from_variant("BUILD_SHARED", "shared"),
            "-DCMAKE_Fortran_MODULE_DIRECTORY=%s" % spec.prefix.include,
            self.define_from_variant("BUILD_DOCS", "docs"),
            self.define_from_variant("OPENMP", "openmp"),
            "-DMAX_RANK=%s" % spec.variants["max_array_rank"].value,
        ]

        if self.spec.satisfies("%gcc@10:"):
            args.append("-DCMAKE_Fortran_FLAGS_DEBUG=-g -O2 -fallow-argument-mismatch")

        if spec.satisfies("@4.0.0:"):
            args.append("-DSKIP_MPI=%s" % ("YES" if "~mpi" in spec else "NO"))
        else:
            args.append(self.define_from_variant("MPI", "mpi"))

        if spec.satisfies("+mpi"):
            args.extend(
                ["-DMPI_USE_MPIEXEC=YES", "-DCMAKE_Fortran_COMPILER=%s" % spec["mpi"].mpifc]
            )

        return args

    def check(self):
        """Searches the CMake-generated Makefile for the target ``test``
        and runs it if found.
        """
        args = ["tests"]
        if self.spec.satisfies("+mpi"):
            args.append("MPI=YES")
        if self.spec.satisfies("+openmp"):
            args.append("OPENMP=YES")
        with working_dir(self.build_directory):
            make(*args)

    def compiler_vendor(self):
        vendors = {
            "%gcc": "GNU",
            "%clang": "GNU",
            "%intel": "Intel",
            "%pgi": "PGI",
            "%nag": "NAG",
            "%cce": "Cray",
        }
        for key, value in vendors.items():
            if self.spec.satisfies(key):
                return value
        raise InstallError("Unsupported compiler.")

    def setup_build_environment(self, env):
        env.set("PFUNIT", self.spec.prefix)
        env.set("F90_VENDOR", self.compiler_vendor())

    def setup_run_environment(self, env):
        env.set("PFUNIT", self.spec.prefix)
        env.set("F90_VENDOR", self.compiler_vendor())

    def setup_dependent_build_environment(self, env, dependent_spec):
        env.set("PFUNIT", self.spec.prefix)
        env.set("F90_VENDOR", self.compiler_vendor())