Skip to content

Add support for M1 Macs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
conormcd wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add support for M1 Macs #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc2df0b
Don't attempt to compile without protoc
conormcd Apr 22, 2022
ce369ed
Emit warnings when Leiningen fails to ID the OS/Arch
conormcd Apr 22, 2022
6cfe2f7
Add support for M1 Macs
conormcd Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 44 additions & 27 deletions src/leiningen/protoc.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,27 +100,31 @@
[{:keys [protoc-exe protoc-grpc-exe]}
{:keys [proto-source-paths builtin-proto-path proto-dep-paths]}
{:keys [proto-target-path grpc-target-path]}]
(let [all-srcs (concat proto-dep-paths (if builtin-proto-path
(conj proto-source-paths builtin-proto-path)
proto-source-paths))
src-paths-args (map str->src-path-arg all-srcs)
target-path-arg (str "--java_out="
(resolve-target-path! proto-target-path))
grpc-plugin-arg (when protoc-grpc-exe
(str "--plugin=protoc-gen-grpc-java="
protoc-grpc-exe))
grpc-path-arg (when protoc-grpc-exe
(str "--grpc-java_out="
(resolve-target-path! grpc-target-path)))
proto-files (mapcat proto-files proto-source-paths)]
(when (and (not-empty proto-files)
(outdated-protos? proto-source-paths proto-target-path))
(main/info "Compiling" (count proto-files) "proto files:" proto-files)
(->> (concat [protoc-exe target-path-arg grpc-plugin-arg grpc-path-arg]
src-paths-args
proto-files)
(remove nil?)
vec))))
(if protoc-exe
(let [all-srcs (concat proto-dep-paths (if builtin-proto-path
(conj proto-source-paths builtin-proto-path)
proto-source-paths))
src-paths-args (map str->src-path-arg all-srcs)
target-path-arg (str "--java_out="
(resolve-target-path! proto-target-path))
grpc-plugin-arg (when protoc-grpc-exe
(str "--plugin=protoc-gen-grpc-java="
protoc-grpc-exe))
grpc-path-arg (when protoc-grpc-exe
(str "--grpc-java_out="
(resolve-target-path! grpc-target-path)))
proto-files (mapcat proto-files proto-source-paths)]
(when (and (not-empty proto-files)
(outdated-protos? proto-source-paths proto-target-path))
(main/info "Compiling" (count proto-files) "proto files:" proto-files)
(->> (concat [protoc-exe target-path-arg grpc-plugin-arg grpc-path-arg]
src-paths-args
proto-files)
(remove nil?)
vec)))
(do
(print-warn-msg "Failed to find a suitable version of protoc")
nil)))

(defn parse-response
[process]
Expand Down Expand Up @@ -183,22 +187,35 @@

(defn get-os
[]
(let [os (leiningen.core.utils/get-os)]
(name (if (= os :macosx) :osx os))))
(if-let [os (leiningen.core.utils/get-os)]
(name (if (= os :macosx) :osx os))
(throw (Exception. "Leiningen failed to identify the OS"))))

(defn get-arch
[]
(let [arch (leiningen.core.utils/get-arch)]
(name (if (= arch :x86) :x86_32 arch))))
(if-let [arch (leiningen.core.utils/get-arch)]
(name (if (= arch :x86) :x86_32 arch))
(throw (Exception. "Leiningen failed to detect the processor architecture"))))

(defn resolve-classifier
"Versions of com.google.protobuf/protoc prior to 3.17.3 don't ship binaries
for osx-aarch_64. However, machines with that architecture are capable of
using the x86_64 variant of protoc using emulation."
[os arch version]
(if (and (= "osx" os)
(= "aarch_64" arch)
(not (leiningen.core.main/version-satisfies? version "3.17.3")))
"osx-x86_64"
(str os "-" arch)))

(defn resolve!
"Resolves the Google Protocol Buffers code generation artifact+version in the
local maven repository if it exists or downloads from Maven Central"
[artifact protoc-version]
(let [classifier (str (get-os) "-" (get-arch))
version (if (= :latest protoc-version)
(let [version (if (= :latest protoc-version)
(latest-version artifact)
protoc-version)
classifier (resolve-classifier (get-os) (get-arch) version)
coordinates [artifact version :classifier classifier :extension "exe"]]
(aether/resolve-artifacts :coordinates [coordinates])
coordinates))
Expand Down
62 changes: 62 additions & 0 deletions test/leiningen/protoc_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
(ns leiningen.protoc-test
(:require [leiningen.protoc :as lp]
[leiningen.core.project :as lcp]
[leiningen.core.utils :as lcu]
[clojure.java.io :as io]
[clojure.test :as t]))

Expand Down Expand Up @@ -60,3 +61,64 @@
(with-open [proto-jar-fs ^java.nio.file.FileSystem (lp/get-jar-fs path)]
(with-open [second-proto-jar-fs ^java.nio.file.FileSystem (lp/get-jar-fs path)]
(t/is (= proto-jar-fs second-proto-jar-fs)))))))

(t/deftest resolve-classifier-test
(t/are [version os arch classifier]
(= classifier (lp/resolve-classifier os arch version))

"3.0.0-beta-2" "windows" "x86_32" "windows-x86_32"
"3.0.0-beta-2" "windows" "x86_64" "windows-x86_64"
"3.0.0-beta-2" "linux" "x86_32" "linux-x86_32"
"3.0.0-beta-2" "linux" "x86_64" "linux-x86_64"
"3.0.0-beta-2" "osx" "x86_64" "osx-x86_64"
"3.0.0-beta-2" "osx" "aarch_64" "osx-x86_64" ; Redirected to x86_64
"3.3.0" "windows" "x86_32" "windows-x86_32"
"3.3.0" "windows" "x86_64" "windows-x86_64"
"3.3.0" "linux" "x86_32" "linux-x86_32"
"3.3.0" "linux" "x86_64" "linux-x86_64"
"3.3.0" "osx" "x86_64" "osx-x86_64"
"3.3.0" "osx" "aarch_64" "osx-x86_64" ; Redirected to x86_64
"3.17.2" "windows" "x86_32" "windows-x86_32"
"3.17.2" "windows" "x86_64" "windows-x86_64"
"3.17.2" "linux" "x86_32" "linux-x86_32"
"3.17.2" "linux" "x86_64" "linux-x86_64"
"3.17.2" "osx" "x86_64" "osx-x86_64"
"3.17.2" "osx" "aarch_64" "osx-x86_64" ; Redirected to x86_64
"3.17.3" "windows" "x86_32" "windows-x86_32"
"3.17.3" "windows" "x86_64" "windows-x86_64"
"3.17.3" "linux" "x86_32" "linux-x86_32"
"3.17.3" "linux" "x86_64" "linux-x86_64"
"3.17.3" "osx" "x86_64" "osx-x86_64"
"3.17.3" "osx" "aarch_64" "osx-aarch_64" ; Uses native aarch_64
"3.18.0" "windows" "x86_32" "windows-x86_32"
"3.18.0" "windows" "x86_64" "windows-x86_64"
"3.18.0" "linux" "x86_32" "linux-x86_32"
"3.18.0" "linux" "x86_64" "linux-x86_64"
"3.18.0" "osx" "x86_64" "osx-x86_64"
"3.18.0" "osx" "aarch_64" "osx-aarch_64" ; Uses native aarch_64
"4.0.0-rc-1" "windows" "x86_32" "windows-x86_32"
"4.0.0-rc-1" "windows" "x86_64" "windows-x86_64"
"4.0.0-rc-1" "linux" "x86_32" "linux-x86_32"
"4.0.0-rc-1" "linux" "x86_64" "linux-x86_64"
"4.0.0-rc-1" "osx" "x86_64" "osx-x86_64"
"4.0.0-rc-1" "osx" "aarch_64" "osx-aarch_64" ; Uses native aarch_64
))

(t/deftest resolve-protoc!-works-with-intel-and-arm-macs
(with-redefs [lcu/get-os (constantly :macosx)]
(t/testing "Old version on an Intel Mac"
(with-redefs [lcu/get-arch (constantly :x86_64)]
(t/is (= "protoc-3.6.0-osx-x86_64.exe"
(.getName (io/file (lp/resolve-protoc! "3.6.0")))))))
(t/testing "Old version on an M1 Mac"
(with-redefs [lcu/get-arch (constantly :aarch_64)]
(t/is (= "protoc-3.6.0-osx-x86_64.exe"
(.getName (io/file (lp/resolve-protoc! "3.6.0")))))))
(t/testing "New version on an Intel Mac"
(with-redefs [lcu/get-arch (constantly :x86_64)]
(t/is (= "protoc-3.20.0-osx-x86_64.exe"
(.getName (io/file (lp/resolve-protoc! "3.20.0")))))))
(t/testing "New version on an M1 Mac"
(with-redefs [lcu/get-arch (constantly :aarch_64)]
(t/is (= "protoc-3.20.0-osx-aarch_64.exe"
(.getName (io/file (lp/resolve-protoc! "3.20.0")))))))))