Add Linux ARM flag to enable experimental build

Add Linux ARM 64-bit build and put it behind a feature flag. Users can enable the Linux ARM build with the `APPSIGNAL_BUILD_FOR_LINUX_ARM` environment variable during installation. This build is behind a flag by default because it requires more testing. People may expect it just works because it gets chosen automatically if we don't put it behind a flag. Now we have an opportunity to warn them beforehand. I made the `Mix.Appsignal.Helper.verify_system_architecture` function public so I could test its behavior like we do for the `agent_platform` function. Docs: https://docs.appsignal.com/support/operating-systems.html#linux-arm-build-override Integrations docs: https://github.com/appsignal/integration-guide/blob/main/build/installation.md#appsignal_build_for_linux_arm
appsignal · Jun 22, 2021 · f467daf · f467daf
1 parent cef261e
commit f467daf
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 22 deletions.
diff --git a/.changesets/linux-arm-build.md b/.changesets/linux-arm-build.md
@@ -0,0 +1,5 @@
+---
+bump: "patch"
+---
+
+Add Linux ARM 64-bit experimental build, available behind a feature flag. To test this set the `APPSIGNAL_BUILD_FOR_LINUX_ARM` flag before compiling your apps: `export APPSIGNAL_BUILD_FOR_LINUX_ARM=1 <command>`. Please be aware this is an experimental build. Please report any issue you may encounter at our [support email](mailto:support@appsignal.com).
diff --git a/agent.exs b/agent.exs
@@ -1,39 +1,43 @@
 defmodule Appsignal.Agent do
-  def version, do: "d08ae6c"
+  def version, do: "9f282f3"
 
   def triples do
     %{
       "x86_64-darwin" => %{
-        checksum: "09a6ab79a1888b0d5101f099c1441477192243e431a2f099137a88dc13bf841e",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-x86_64-darwin-all-static.tar.gz"
+        checksum: "c279d061ac04b53c8e2ea21b7714d4d54964495124ddc7e794ba998366f9c195",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "universal-darwin" => %{
-        checksum: "09a6ab79a1888b0d5101f099c1441477192243e431a2f099137a88dc13bf841e",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-x86_64-darwin-all-static.tar.gz"
+        checksum: "c279d061ac04b53c8e2ea21b7714d4d54964495124ddc7e794ba998366f9c195",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-x86_64-darwin-all-static.tar.gz"
+      },
+      "aarch64-linux" => %{
+        checksum: "3054b6e3bcab8c8959d4e87eb6fd9fc7a5821e0986c8e733154c2b76251c9e70",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-aarch64-linux-all-static.tar.gz"
       },
       "i686-linux" => %{
-        checksum: "976a43a8679bd69fc58b0f2dd2a15e9dc28ff27b5bd971a9c33cb75ee7f5f2d3",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-i686-linux-all-static.tar.gz"
+        checksum: "30554989a59632cdaf8fdf5d15024b866d32930e91c080425955842e8078952b",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-i686-linux-all-static.tar.gz"
       },
       "x86-linux" => %{
-        checksum: "976a43a8679bd69fc58b0f2dd2a15e9dc28ff27b5bd971a9c33cb75ee7f5f2d3",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-i686-linux-all-static.tar.gz"
+        checksum: "30554989a59632cdaf8fdf5d15024b866d32930e91c080425955842e8078952b",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-i686-linux-all-static.tar.gz"
       },
       "x86_64-linux" => %{
-        checksum: "f5ddf0914c285849a5f765ee15d7ea6a7c5ab415aa949fb0a521edd82516caa7",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-x86_64-linux-all-static.tar.gz"
+        checksum: "f11fa7ec493c3668e965ef4cff077d44fe55101197a5eeaf50ccacf7314eba2b",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-x86_64-linux-all-static.tar.gz"
       },
       "x86_64-linux-musl" => %{
-        checksum: "c00fdf7f24ef459314eb9294c645df1517c1062498897abfc71b092f0fd26eb6",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-x86_64-linux-musl-all-static.tar.gz"
+        checksum: "0dae02e77e244275b69bb8332e79bdcb0e0fa3b6b6f84744780ce0baffa9784f",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-x86_64-linux-musl-all-static.tar.gz"
       },
       "x86_64-freebsd" => %{
-        checksum: "cd6b80873e94a6f79a62bda6ca0058d97f4fccef4b07f5abde198d8df582de0d",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-x86_64-freebsd-all-static.tar.gz"
+        checksum: "d9146a04bbbb85dccf22c84cacfa924ee8b7e2ff8ed79402aba14ac4333e440f",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "amd64-freebsd" => %{
-        checksum: "cd6b80873e94a6f79a62bda6ca0058d97f4fccef4b07f5abde198d8df582de0d",
-        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/d08ae6c/appsignal-x86_64-freebsd-all-static.tar.gz"
+        checksum: "d9146a04bbbb85dccf22c84cacfa924ee8b7e2ff8ed79402aba14ac4333e440f",
+        download_url: "https://appsignal-agent-releases.global.ssl.fastly.net/9f282f3/appsignal-x86_64-freebsd-all-static.tar.gz"
       },
     }
   end

diff --git a/mix_helpers.exs b/mix_helpers.exs
@@ -263,8 +263,13 @@ defmodule Mix.Appsignal.Helper do
   defp make_args("test" <> _), do: ["-e", "CFLAGS_ADD=-DTEST"]
   defp make_args(_), do: []
 
-  defp verify_system_architecture(report) do
-    input_arch = :erlang.system_info(:system_architecture)
+  def verify_system_architecture(report) do
+    input_arch =
+      if force_linux_arm_build?() do
+        'aarch64-linux'
+      else
+        :erlang.system_info(:system_architecture)
+      end
 
     case map_arch(input_arch, agent_platform()) do
       {:ok, {arch, target} = architecture} ->
@@ -299,6 +304,7 @@ defmodule Mix.Appsignal.Helper do
     defp map_arch('x86-' ++ _, platform), do: build_for("i686", platform)
     defp map_arch('amd64-' ++ _, platform), do: build_for("x86_64", platform)
     defp map_arch('x86_64-' ++ _, platform), do: build_for("x86_64", platform)
+    defp map_arch('aarch64-' ++ _, platform), do: build_for("aarch64", platform)
   end
 
   defp map_arch(arch, platform), do: {:error, {:unknown, {arch, platform}}}
@@ -385,11 +391,14 @@ defmodule Mix.Appsignal.Helper do
   end
 
   def agent_platform do
-    case force_musl_build?() do
-      true ->
+    cond do
+      force_linux_arm_build?() == true ->
+        "linux"
+
+      force_musl_build?() == true ->
         "linux-musl"
 
-      false ->
+      true ->
         case @os.type() do
           {:unix, :linux} ->
             agent_platform_by_ldd_version()
@@ -631,6 +640,11 @@ defmodule Mix.Appsignal.Helper do
     env == "1" || env == "true"
   end
 
+  defp force_linux_arm_build? do
+    env = System.get_env("APPSIGNAL_BUILD_FOR_LINUX_ARM")
+    env == "1" || env == "true"
+  end
+
   defp make do
     if System.find_executable("gmake"), do: "gmake", else: "make"
   end

diff --git a/test/mix/helpers_test.exs b/test/mix/helpers_test.exs
@@ -11,6 +11,51 @@ defmodule Mix.Appsignal.HelperTest do
     [fake_os: start_supervised!(FakeOS), fake_system: start_supervised!(FakeSystem)]
   end
 
+  describe ".verify_system_architecture" do
+    @tag :skip_env_test_no_nif
+    test "returns 64-bit Linux build" do
+      report = %{build: %{}}
+
+      assert Mix.Appsignal.Helper.verify_system_architecture(report) == {
+               :ok,
+               {
+                 {"x86_64", "linux"},
+                 %{build: %{architecture: "x86_64", target: "linux"}}
+               }
+             }
+    end
+
+    @tag :skip_env_test_no_nif
+    test "returns the 64-bit Linux ARM build when using the APPSIGNAL_BUILD_FOR_LINUX_ARM='1' env var" do
+      with_env(%{"APPSIGNAL_BUILD_FOR_LINUX_ARM" => "1"}, fn ->
+        report = %{build: %{}}
+
+        assert Mix.Appsignal.Helper.verify_system_architecture(report) == {
+                 :ok,
+                 {
+                   {"aarch64", "linux"},
+                   %{build: %{architecture: "aarch64", target: "linux"}}
+                 }
+               }
+      end)
+    end
+
+    @tag :skip_env_test_no_nif
+    test "returns the 64-bit Linux ARM build when using the APPSIGNAL_BUILD_FOR_LINUX_ARM='true' env var" do
+      with_env(%{"APPSIGNAL_BUILD_FOR_LINUX_ARM" => "true"}, fn ->
+        report = %{build: %{}}
+
+        assert Mix.Appsignal.Helper.verify_system_architecture(report) == {
+                 :ok,
+                 {
+                   {"aarch64", "linux"},
+                   %{build: %{architecture: "aarch64", target: "linux"}}
+                 }
+               }
+      end)
+    end
+  end
+
   describe ".agent_platform" do
     test "returns libc build when the system detection doesn't work" do
       assert Mix.Appsignal.Helper.agent_platform() == "linux"