Add architecture checks for macOS installers (#1153)

* Add arm64 checks for SH installers

* Add architecture check to PKG installers

* Add news

* Add missing template parameter to shellcheck test

* Fix architecture name for Intel PKG installers

Author: marcoesters

constructor/header.sh

@@ -246,6 +246,21 @@ then
             exit 2
         fi
     fi
+{%- elif arm64 %}
+    if [ "$(uname -m)" != "arm64" ]; then
+        printf "WARNING:\\n"
+        printf "    Your machine hardware does not appear to be arm64, \\n"
+        printf "    but you are trying to install an arm64 version of %s.\\n" "${INSTALLER_NAME}"
+        printf "    Are sure you want to continue the installation? [yes|no]\\n"
+        printf "[no] >>> "
+        read -r ans
+        ans=$(echo "${ans}" | tr '[:lower:]' '[:upper:]')
+        if [ "$ans" != "YES" ] && [ "$ans" != "Y" ]
+        then
+            printf "Aborting installation\\n"
+            exit 2
+        fi
+    fi
 {%- elif ppc64le %}
     if [ "$(uname -m)" != "ppc64le" ]; then
         printf "WARNING:\\n"
@@ -280,7 +295,7 @@ then
     if [ "$(uname -m)" != "aarch64" ]; then
         printf "WARNING:\\n"
         printf "    Your machine hardware does not appear to be aarch64, \\n"
-        printf "    but you are trying to install a aarch64 version of %s.\\n" "${INSTALLER_NAME}"
+        printf "    but you are trying to install an aarch64 version of %s.\\n" "${INSTALLER_NAME}"
         printf "    Are sure you want to continue the installation? [yes|no]\\n"
         printf "[no] >>> "
         read -r ans

constructor/osxpkg.py

@@ -213,6 +213,10 @@ def modify_xml(xml_path, info):
         options.set("customize", "allow")
         options.set("customLocation", "/")
 
+    arch = "arm64" if info["_platform"] == "osx-arm64" else "x86_64"
+    arch_key = ET.Element("options", hostArchitectures=arch)
+    root.append(arch_key)
+
     # By default, the package builder puts all of our options under
     # a single master choice. This deletes that master choice and
     # allows the user to see all options without effort.

news/1153-macos-architecture-checks

@@ -0,0 +1,19 @@
+### Enhancements
+
+* Add architecture checks to macOS SH and PKG installers. (#1153)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>

tests/test_header.py

@@ -91,7 +91,7 @@ def test_osxpkg_scripts_shellcheck(arch, check_path_spaces, script):
 @pytest.mark.parametrize("initialize_by_default", [True])
 @pytest.mark.parametrize("has_post_install", [True])
 @pytest.mark.parametrize("has_pre_install", [False])
-@pytest.mark.parametrize("arch", ["x86_64", "aarch64"])
+@pytest.mark.parametrize("arch", ["x86_64", "aarch64", "arm64"])
 @pytest.mark.parametrize("check_path_spaces", [True])
 @pytest.mark.parametrize("enable_shortcuts", ["true"])
 @pytest.mark.parametrize("min_glibc_version", ["2.17"])
@@ -130,6 +130,7 @@ def test_template_shellcheck(
             "ppc64le": arch == "ppc64le",
             "s390x": arch == "s390x",
             "aarch64": arch == "aarch64",
+            "arm64": arch == "arm64",
             "linux": not osx,
             "has_pre_install": has_pre_install,
             "direct_execute_pre_install": direct_execute_pre_install,