8000 add linux support by mrj0 · Pull Request #19 · crhuber/kelp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

add linux support #19

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.

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

Merged
merged 1 commit into from
May 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
module crhuber/kelp

go 1.21
toolchain go1.23.7
go 1.23.0

toolchain go1.23.8

require (
github.com/gabriel-vasile/mimetype v1.3.1
Expand Down
6 changes: 6 additions & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package main
import (
"crhuber/kelp/pkg/config"
"crhuber/kelp/pkg/install"
"crhuber/kelp/pkg/types"
"crhuber/kelp/pkg/utils"
"errors"
"fmt"
Expand All @@ -26,6 +27,11 @@ func main() {
var home, _ = os.UserHomeDir()
var KelpConf = filepath.Join(home, "/.kelp/kelp.json")

if types.GetCapabilities() == nil {
fmt.Println("Sorry, your OS is not yet supported.")
os.Exit(1)
}

app := &cli.App{
Name: "kelp",
Version: version,
Expand Down
14 changes: 9 additions & 5 deletions pkg/config/config.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package config

import (
"crhuber/kelp/pkg/types"
"crhuber/kelp/pkg/utils"
"encoding/json"
"errors"
Expand All @@ -10,7 +11,6 @@ import (
"os/exec"
"path/filepath"
"regexp"
"runtime"
"sort"
"strings"
"text/tabwriter"
Expand Down Expand Up @@ -240,9 +240,11 @@ func Initialize(path string) error {

func Inspect() {
var err error
switch runtime.GOOS {
case "darwin":
switch types.GetOS() {
case types.Darwin:
err = exec.Command("open", KelpDir).Start()
case types.Linux:
err = exec.Command("xdg-open", KelpDir).Start()
default:
err = fmt.Errorf("unsupported platform")
}
Expand All @@ -256,9 +258,11 @@ func Browse(owner, repo string) {
url := fmt.Sprintf("https://github.com/%s/%s", owner, repo)
fmt.Printf("Opening %s\n", url)

switch runtime.GOOS {
case "darwin":
switch types.GetOS() {
case types.Darwin:
err = exec.Command("open", url).Start()
case types.Linux:
err = exec.Command("xdg-open", url).Start()
default:
err = fmt.Errorf("unsupported platform")
}
Expand Down
19 changes: 11 additions & 8 deletions pkg/install/install.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func Install(owner, repo, release string) error {
return err
}
destinations := installBinary(tempdir)
if runtime.GOOS == "darwin" {
if types.IsDarwin() {
for _, d := range destinations {
unquarantineFile(d)
}
Expand Down Expand Up @@ -209,10 +209,11 @@ func installBinary(tempDir string) []string {
log.Panic("Could not walk directory")
}
destinations := []string{}
osCap := types.GetCapabilities()
for _, file := range files {
mime, _ := mimetype.DetectFile(string(file))
// only install binary files
if mime.String() == "application/x-mach-binary" {
if mime.String() == osCap.ExecutableMime {
splits := strings.SplitAfter(file, "/")
fileName := splits[len(splits)-1]
fmt.Printf("Binary file %s found in extract.\n", fileName)
Expand All @@ -221,6 +222,8 @@ func installBinary(tempDir string) []string {
utils.CopyFile(file, destination)
fmt.Printf("✅ Installed %v !\n", fileName)
destinations = append(destinations, destination)
} else {
fmt.Printf("not executable: %v - %v\n", file, mime.String())
}
}
return destinations
Expand All @@ -239,12 +242,12 @@ func getHighestScore(assetScores map[int]int) Pair {
return assetsByScore[len(assetsByScore)-1]
}

func evaluateAssetSuitability(asset types.Asset) int {
func evaluateAssetSuitability(capabilities *types.Capabilities, asset types.Asset) int {
assetScore := 0
if asset.IsMacAsset() {
if asset.IsSameOS(capabilities) {
assetScore += 4
}
if asset.IsSameArchitecture() {
if asset.IsSameArchitecture(capabilities) {
assetScore += 3
}
if asset.IsDownloadableExtension() {
Expand All @@ -259,19 +262,19 @@ func evaluateAssetSuitability(asset types.Asset) int {

func findGithubReleaseMacAssets(assets []types.Asset) (types.Asset, error) {

fmt.Println("🍏 Finding mac assets to download...")
fmt.Println("🍏 Finding assets to download...")
assetScores := map[int]int{}
for index, asset := range assets {
filename := strings.Split(asset.BrowserDownloadURL, "/")
assetScore := evaluateAssetSuitability(asset)
assetScore := evaluateAssetSuitability(types.GetCapabilities(), asset)
if assetScore >= 6 {
fmt.Printf("Found suitable candiate %v for download. Score: %v\n", filename[len(filename)-1], assetScore)
assetScores[index] = assetScore
}

}
if len(assetScores) == 0 {
return types.Asset{}, errors.New("could not find a github asset with mac binaries")
return types.Asset{}, errors.New("could not find a github asset")
}

// sort the map by value of score.
Expand Down
79 changes: 66 additions & 13 deletions pkg/install/intstall_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,26 @@ import (
"testing"

"github.com/stretchr/testify/require"
"runtime"
)

func TestFindGithubReleaseMacAssets(t *testing.T) {

var assets []types.Asset
asset1 := types.Asset{
BrowserDownloadURL: "https://github.com/trufflesecurity/trufflehog/releases/download/v3.60.1/trufflehog_3.60.1_darwin_amd64.tar.gz",
BrowserDownloadURL: "https://github.com/trufflesecurity/trufflehog/releases/download/v3.60.1/trufflehog_3.60.1_" + runtime.GOOS + "_amd64.tar.gz",
}
asset2 := types.Asset{
BrowserDownloadURL: "https://github.com/trufflesecurity/trufflehog/releases/download/v3.60.1/trufflehog_3.60.1_darwin_arm64.tar.gz",
BrowserDownloadURL: "https://github.com/trufflesecurity/trufflehog/releases/download/v3.60.1/trufflehog_3.60.1_" + runtime.GOOS + "_arm64.tar.gz",
}
assets = append(assets, asset1, asset2)

downloadableAssets, _ := findGithubReleaseMacAssets(assets)
require.Equal(t, asset2, downloadableAssets)
if runtime.GOOS == "arm64" {
require.Equal(t, asset2, downloadableAssets)
} else {
require.Equal(t, asset1, downloadableAssets)
}
}

func TestGetHighestScore(t *testing.T) {
Expand All @@ -34,40 +39,88 @@ func TestGetHighestScore(t *testing.T) {
require.Equal(t, assetsByScore.Value, assetScores[3])
}

func TestEvalAssetSuitability(t *testing.T) {
func TestEvalAssetSuitabilityDarwin(t *testing.T) {
// pluto_4.2.0_darwin_amd64.tar.gz = 9
// ruplacer-osx = 6
// croc_9.2.0_macOS-64bit.tar.gz = 7
// conftest_0.28.1_Darwin_x86_64.tar.gz = 7
// conftest_0.28.1_Darwin_arm64.tar.gz = 6
// pandoc-2.14.2-macOS.pkg = 6
// direnv.darwin-amd64 =8
osCap := &types.Capabilities{
OS: types.Darwin,
ExecutableMime: "application/x-mach-binary",
Arch: "arm64",
}
asset := types.Asset{
BrowserDownloadURL: "https://github.com/foo/bar/releases/download/v1.0/direnv.darwin-arm64",
}
require.Equal(t, 7, evaluateAssetSuitability(asset))
require.Equal(t, 7, evaluateAssetSuitability(osCap, asset))
// pluto_4.2.0_darwin_amd64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/pluto_4.2.0_darwin_arm64.tar.gz"
require.Equal(t, 9, evaluateAssetSuitability(asset))
require.Equal(t, 9, evaluateAssetSuitability(osCap, asset))
// ruplacer-osx
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/ruplacer-osx"
require.Equal(t, 5, evaluateAssetSuitability(asset))
require.Equal(t, 5, evaluateAssetSuitability(osCap, asset))
// croc_9.2.0_macOS-64bit.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/croc_9.2.0_macOS-64bit.tar.gz"
require.Equal(t, 6, evaluateAssetSuitability(asset))
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// conftest_0.28.1_Darwin_x86_64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/conftest_0.28.1_Darwin_x86_64.tar.gz"
require.Equal(t, 6, evaluateAssetSuitability(asset))
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// conftest_0.28.1_Darwin_arm64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/conftest_0.28.1_Darwin_arm64.tar.gz"
require.Equal(t, 9, evaluateAssetSuitability(asset))
require.Equal(t, 9, evaluateAssetSuitability(osCap, asset))
// pandoc-2.14.2-macOS.pkg
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/pandoc-2.14.2-macOS.pkg"
require.Equal(t, 6, evaluateAssetSuitability(asset))
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// gopass-1.15.11-darwin-amd64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/gopass-1.15.11-darwin-amd64.tar.gz"
require.Equal(t, 6, evaluateAssetSuitability(asset))
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// gopass-1.15.11-darwin-arm64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/gopass-1.15.11-darwin-arm64.tar.gz"
require.Equal(t, 9, evaluateAssetSuitability(asset))
require.Equal(t, 9, evaluateAssetSuitability(osCap, asset))
}

func TestEvalAssetSuitabilityLinux(t *testing.T) {
// pluto_4.2.0_darwin_amd64.tar.gz = 9
// ruplacer-osx = 6
// croc_9.2.0_macOS-64bit.tar.gz = 7
// conftest_0.28.1_Darwin_x86_64.tar.gz = 7
// conftest_0.28.1_Darwin_arm64.tar.gz = 6
// pandoc-2.14.2-macOS.pkg = 6
// direnv.darwin-amd64 =8
osCap := &types.Capabilities{
OS: types.Linux,
ExecutableMime: "asdf",
Arch: "amd64",
}
asset := types.Asset{
BrowserDownloadURL: "https://github.com/foo/bar/releases/download/v1.0/direnv.linux-amd64",
}
require.Equal(t, 7, evaluateAssetSuitability(osCap, asset))
// pluto_4.2.0_darwin_amd64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/pluto_4.2.0_linux_amd64.tar.gz"
require.Equal(t, 9, evaluateAssetSuitability(osCap, asset))
// ruplacer-osx
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/ruplacer-linux"
require.Equal(t, 5, evaluateAssetSuitability(osCap, asset))
// croc_9.2.0_macOS-64bit.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/croc_9.2.0_linuX-64bit.tar.gz"
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// conftest_0.28.1_Darwin_x86_64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/conftest_0.28.1_Linux_x86_64.tar.gz"
require.Equal(t, 9, evaluateAssetSuitability(osCap, asset))
// conftest_0.28.1_Darwin_arm64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/conftest_0.28.1_Linux_arm64.tar.gz"
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// pandoc-2.14.2-macOS.pkg
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/pandoc-2.14.2-linux.pkg"
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// gopass-1.15.11-darwin-amd64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/gopass-1.15.11-linux-arm64.tar.gz"
require.Equal(t, 6, evaluateAssetSuitability(osCap, asset))
// gopass-1.15.11-darwin-arm64.tar.gz
asset.BrowserDownloadURL = "https://github.com/foo/bar/releases/download/v1.0/gopass-1.15.11-linux-amd64.tar.gz"
require.Equal(t, 9, evaluateAssetSuitability(osCap, asset))
}
33 changes: 27 additions & 6 deletions pkg/types/github.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package types

import (
"runtime"
"strings"
"time"
)
Expand Down Expand Up @@ -95,14 +94,36 @@ func (a Asset) IsMacAsset() bool {
return false
}

func (a Asset) IsSameArchitecture() bool {
if strings.Contains(strings.ToLower(a.BrowserDownloadURL), strings.ToLower(runtime.GOARCH)) {
func (a Asset) IsLinuxAsset() bool {
macIdentifiers := []string{"linux"}

for _, word := range macIdentifiers {
result := strings.Contains(strings.ToLower(a.BrowserDownloadURL), word)
if result {
return result
}
}
return false
}

func (a Asset) IsSameOS(capabilities *Capabilities) bool {
switch capabilities.OS {
case Darwin:
return a.IsMacAsset()
case Linux:
return a.IsLinuxAsset()
}
return false
}

func (a Asset) IsSameArchitecture(capabilities *Capabilities) bool {
if strings.Contains(strings.ToLower(a.BrowserDownloadURL), strings.ToLower(capabilities.Arch)) {
return true
} else if runtime.GOARCH == "amd64" && strings.Contains(strings.ToLower(a.BrowserDownloadURL), "x86_64") {
} else if capabilities.Arch == "amd64" && strings.Contains(strings.ToLower(a.BrowserDownloadURL), "x86_64") {
return true
} else if runtime.GOARCH == "arm64" && strings.Contains(strings.ToLower(a.BrowserDownloadURL), "arm64") {
} else if capabilities.Arch == "arm64" && strings.Contains(strings.ToLower(a.BrowserDownloadURL), "arm64") {
return true
} else if runtime.GOARCH == "arm64" && strings.Contains(strings.ToLower(a.BrowserDownloadURL), "aarch64") {
} else if capabilities.Arch == "arm64" && strings.Contains(strings.ToLower(a.BrowserDownloadURL), "aarch64") {
return true
} else {
return false
Expand Down
53 changes: 53 additions & 0 deletions pkg/types/os.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package types

import (
"runtime"
)

type OS int

const (
Darwin OS = iota
Linux
)

func IsDarwin() bool {
return runtime.GOOS == "darwin"
}

func IsLinux() bool {
return runtime.GOOS == "linux"
}

type Capabilities struct {
OS OS
ExecutableMime string
Arch string
}

func GetOS() OS {
if runtime.GOOS == "darwin" {
return Darwin
}
if runtime.GOOS == "linux" {
return Linux
}
return -1
}

var current *Capabilities

func GetCapabilities() *Capabilities {
if current != nil {
return current
}

switch runtime.GOOS {
case "darwin":
current = &Capabilities{OS: Darwin, ExecutableMime: "application/x-mach-binary"}
case "linux":
current = &Capabilities{OS: Linux, ExecutableMime: "application/x-executable"}
}
current.Arch = runtime.GOARCH
return current
}
0