Merge pull request #6 from gabriel-samfira/add-build-scripts

Update garm-provider-common and add build scripts

.github/workflows/go-tests.yml

@@ -24,4 +24,4 @@ jobs:
       - run: go version
 
       - name: Run GARM Go Tests
-        run: make go-test
+        run: make test

.gitignore

@@ -1 +1,3 @@
-/bin
+bin/
+release/
+build/

Dockerfile

@@ -0,0 +1,15 @@
+FROM docker.io/golang:alpine
+
+WORKDIR /root
+USER root
+
+RUN apk add musl-dev gcc libtool m4 autoconf g++ make libblkid util-linux-dev git linux-headers mingw-w64-gcc
+
+RUN wget http://musl.cc/aarch64-linux-musl-cross.tgz -O /tmp/aarch64-linux-musl-cross.tgz && \
+    tar --strip-components=1 -C /usr/local -xzf /tmp/aarch64-linux-musl-cross.tgz && \
+    rm /tmp/aarch64-linux-musl-cross.tgz
+
+ADD ./scripts/build-static.sh /build-static.sh
+RUN chmod +x /build-static.sh
+
+CMD ["/bin/sh"]

Makefile

@@ -1,6 +1,60 @@
 SHELL := bash
 
-.PHONY: go-test
+ROOTDIR=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+GOPATH ?= $(shell go env GOPATH)
+GO ?= go
+
+IMAGE_TAG = garm-provider-build
+
+USER_ID=$(shell ((docker --version | grep -q podman) && echo "0" || id -u))
+USER_GROUP=$(shell ((docker --version | grep -q podman) && echo "0" || id -g))
+GARM_PROVIDER_NAME := garm-provider-oci
+
+default: build
+
+.PHONY : build build-static test install-lint-deps lint go-test fmt fmtcheck verify-vendor verify create-release-files release
+
+build:
+	@$(GO) build .
+
+clean: ## Clean up build artifacts
+	@rm -rf ./bin ./build ./release
+
+build-static:
+	@echo Building
+	docker build --tag $(IMAGE_TAG) .
+	mkdir -p build
+	docker run --rm -e GARM_PROVIDER_NAME=$(GARM_PROVIDER_NAME) -e USER_ID=$(USER_ID) -e USER_GROUP=$(USER_GROUP) -v $(PWD)/build:/build/output:z -v $(PWD):/build/$(GARM_PROVIDER_NAME):z $(IMAGE_TAG) /build-static.sh
+	@echo Binaries are available in $(PWD)/build
+
+test: install-lint-deps verify go-test
+
+install-lint-deps:
+	@$(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
+lint:
+	@golangci-lint run --timeout=8m --build-tags testing
 
 go-test:
-	go test -v ./... $(TEST_ARGS) -timeout=15m -parallel=4
+	@$(GO) test -race -mod=vendor -tags testing -v $(TEST_ARGS) -timeout=15m -parallel=4 -count=1 ./...
+
+fmt:
+	@$(GO) fmt $$(go list ./...)
+
+fmtcheck:
+	@gofmt -l -s $$(go list ./... | sed -n 's/github.com\/cloudbase\/'$(GARM_PROVIDER_NAME)'\/\(.*\)/\1/p') | grep ".*\.go"; if [ "$$?" -eq 0 ]; then echo "gofmt check failed; please tun gofmt -w -s"; exit 1;fi
+
+verify-vendor: ## verify if all the go.mod/go.sum files are up-to-date
+	$(eval TMPDIR := $(shell mktemp -d))
+	@cp -R ${ROOTDIR} ${TMPDIR}
+	@(cd ${TMPDIR}/$(GARM_PROVIDER_NAME) && ${GO} mod tidy)
+	@diff -r -u -q ${ROOTDIR} ${TMPDIR}/$(GARM_PROVIDER_NAME) >/dev/null 2>&1; if [ "$$?" -ne 0 ];then echo "please run: go mod tidy && go mod vendor"; exit 1; fi
+	@rm -rf ${TMPDIR}
+
+verify: verify-vendor lint fmtcheck
+
+##@ Release
+create-release-files:
+	./scripts/make-release.sh
+
+release: build-static create-release-files ## Create a release

go.mod

@@ -1,10 +1,12 @@
 module github.com/cloudbase/garm-provider-oci
 
-go 1.21.3
+go 1.22
+
+toolchain go1.22.3
 
 require (
 	github.com/BurntSushi/toml v1.3.2
-	github.com/cloudbase/garm-provider-common v0.1.2
+	github.com/cloudbase/garm-provider-common v0.1.3
 	github.com/oracle/oci-go-sdk/v49 v49.2.0
 	github.com/stretchr/testify v1.9.0
 	github.com/xeipuuv/gojsonschema v1.2.0
@@ -24,8 +26,8 @@ require (
 	github.com/teris-io/shortid v0.0.0-20220617161101-71ec9f2aa569 // indirect
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
-	golang.org/x/crypto v0.23.0 // indirect
-	golang.org/x/sys v0.20.0 // indirect
+	golang.org/x/crypto v0.25.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,7 +1,7 @@
 github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
 github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
-github.com/cloudbase/garm-provider-common v0.1.2 h1:EqSpUjw9rzo4PiUmteHkFtZNWCnRi0QXHRKZ+VA1IPo=
-github.com/cloudbase/garm-provider-common v0.1.2/go.mod h1:igxJRT3OlykERYc6ssdRQXcb+BCaeSfnucg6I0OSoDc=
+github.com/cloudbase/garm-provider-common v0.1.3 h1:8pHSRs2ljwLHgtDrge68dZ7ILUW97VF5h2ZA2fQubGQ=
+github.com/cloudbase/garm-provider-common v0.1.3/go.mod h1:VIJzbcg5iwyD4ac99tnnwcActfwibn/VOt2MYOFjf2c=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -40,11 +40,11 @@ github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 h1:EzJWgHo
 github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ=
 github.com/xeipuuv/gojsonschema v1.2.0 h1:LhYJRs+L4fBtjZUfuSZIKGeVu0QRy8e5Xi7D17UxZ74=
 github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y=
-golang.org/x/crypto v0.23.0 h1:dIJU/v2J8Mdglj/8rJ6UUOM3Zc9zLZxVZwwxMooUSAI=
-golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
+golang.org/x/crypto v0.25.0 h1:ypSNr+bnYL2YhwoMt2zPxHFmbAN1KZs/njMG3hxUp30=
+golang.org/x/crypto v0.25.0/go.mod h1:T+wALwcMOSE0kXgUAnPAHqTLW+XHgcELELW8VaDgm/M=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
-golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
+golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=

internal/spec/spec.go

@@ -162,7 +162,9 @@ func GetRunnerSpecFromBootstrapParams(cfg *config.Config, data params.BootstrapI
 	}
 
 	spec.MergeExtraSpecs(extraSpecs)
-	spec.SetUserData()
+	if err := spec.SetUserData(); err != nil {
+		return nil, fmt.Errorf("error setting extra specs: %w", err)
+	}
 
 	return spec, nil
 }

internal/spec/spec_test.go

@@ -172,6 +172,7 @@ func TestGetRunnerSpecFromBootstrapParams(t *testing.T) {
 		return Mocktools, nil
 	}
 	data := params.BootstrapInstance{
+		OSType: params.Linux,
 		ExtraSpecs: json.RawMessage(`{
 			"ocpus": 2,
 			"memory_in_gbs": 8,
@@ -213,6 +214,7 @@ func TestGetRunnerSpecFromBootstrapParams(t *testing.T) {
 
 	spec, err := GetRunnerSpecFromBootstrapParams(config, data, "MockControllerID")
 	assert.Nil(t, err)
+	spec.UserData = ""
 	assert.Equal(t, ExpectedRunnerSpec, spec)
 }
 

main.go

@@ -31,7 +31,22 @@ var signals = []os.Signal{
 	syscall.SIGTERM,
 }
 
+var (
+	// Version is the version of the application
+	Version = "v0.0.0-unknown"
+)
+
 func main() {
+	// This is an unofficial command. It will be added into future versions of the
+	// external provider interface. For now we manually hardcode it here. This is not
+	// used by GARM itself. It is informative for the user to be able to check the version
+	// of the provider.
+	garmCommand := os.Getenv("GARM_COMMAND")
+	if garmCommand == "GetVersion" {
+		fmt.Println(Version)
+		os.Exit(0)
+	}
+
 	ctx, stop := signal.NotifyContext(context.Background(), signals...)
 	defer stop()
 

scripts/build-static.sh

@@ -0,0 +1,48 @@
+#!/bin/sh
+
+GARM_PROVIDER_NAME=${GARM_PROVIDER_NAME:-garm-provider-oci}
+GARM_SOURCE="/build/$GARM_PROVIDER_NAME"
+git config --global --add safe.directory /build/$GARM_PROVIDER_NAME
+cd $GARM_SOURCE
+
+CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+if [ ! -z "$GARM_REF" ] && [ "$GARM_REF" != "$CURRENT_BRANCH" ];then
+    git checkout $GARM_REF
+fi
+
+cd $GARM_SOURCE
+
+OUTPUT_DIR="/build/output"
+VERSION=$(git describe --tags --match='v[0-9]*' --dirty --always)
+BUILD_DIR="$OUTPUT_DIR/$VERSION"
+
+
+[ ! -d "$BUILD_DIR/linux" ] && mkdir -p "$BUILD_DIR/linux"
+[ ! -d "$BUILD_DIR/windows" ] && mkdir -p "$BUILD_DIR/windows"
+
+export CGO_ENABLED=1
+USER_ID=${USER_ID:-$UID}
+USER_GROUP=${USER_GROUP:-$(id -g)}
+
+# Garm
+cd $GARM_SOURCE
+
+# Linux
+GOOS=linux GOARCH=amd64 go build -mod vendor \
+    -o $BUILD_DIR/linux/amd64/$GARM_PROVIDER_NAME \
+    -tags osusergo,netgo,sqlite_omit_load_extension \
+    -ldflags "-extldflags '-static' -s -w -X main.Version=$VERSION" .
+GOOS=linux GOARCH=arm64 CC=aarch64-linux-musl-gcc go build \
+    -mod vendor \
+    -o $BUILD_DIR/linux/arm64/$GARM_PROVIDER_NAME \
+    -tags osusergo,netgo,sqlite_omit_load_extension \
+    -ldflags "-extldflags '-static' -s -w -X main.Version=$VERSION" .
+
+# Windows
+GOOS=windows GOARCH=amd64 CC=x86_64-w64-mingw32-cc go build -mod vendor \
+    -o $BUILD_DIR/windows/amd64/$GARM_PROVIDER_NAME.exe \
+    -tags osusergo,netgo,sqlite_omit_load_extension \
+    -ldflags "-s -w -X main.Version=$VERSION" .
+
+git checkout $CURRENT_BRANCH || true
+chown $USER_ID:$USER_GROUP -R "$OUTPUT_DIR"

scripts/make-release.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+echo $GARM_REF
+GARM_PROVIDER_NAME=${GARM_PROVIDER_NAME:-garm-provider-oci}
+
+VERSION=$(git describe --tags --match='v[0-9]*' --dirty --always)
+RELEASE="$PWD/release"
+
+[ ! -d "$RELEASE" ] && mkdir -p "$RELEASE"
+
+if [ ! -z "$GARM_REF" ]; then
+    VERSION=$(git describe --tags --match='v[0-9]*' --always $GARM_REF)
+fi
+
+echo $VERSION
+
+if [ ! -d "build/$VERSION" ]; then
+    echo "missing build/$VERSION"
+    exit 1
+fi
+
+# Windows
+
+if [ ! -d "build/$VERSION/windows/amd64" ];then
+    echo "missing build/$VERSION/windows/amd64"
+    exit 1
+fi
+
+if [ ! -f "build/$VERSION/windows/amd64/$GARM_PROVIDER_NAME.exe" ];then
+    echo "missing build/$VERSION/windows/amd64/$GARM_PROVIDER_NAME.exe"
+    exit 1
+fi
+
+pushd build/$VERSION/windows/amd64
+zip $GARM_PROVIDER_NAME-windows-amd64.zip $GARM_PROVIDER_NAME.exe
+sha256sum $GARM_PROVIDER_NAME-windows-amd64.zip > $GARM_PROVIDER_NAME-windows-amd64.zip.sha256
+mv $GARM_PROVIDER_NAME-windows-amd64.zip $RELEASE
+mv $GARM_PROVIDER_NAME-windows-amd64.zip.sha256 $RELEASE
+popd
+
+# Linux
+OS_ARCHES=("amd64" "arm64")
+
+for arch in ${OS_ARCHES[@]};do
+    if [ ! -f "build/$VERSION/linux/$arch/$GARM_PROVIDER_NAME" ];then
+        echo "missing build/$VERSION/linux/$arch/$GARM_PROVIDER_NAME"
+        exit 1
+    fi
+
+    pushd build/$VERSION/linux/$arch
+    tar czf $GARM_PROVIDER_NAME-linux-$arch.tgz $GARM_PROVIDER_NAME
+    sha256sum $GARM_PROVIDER_NAME-linux-$arch.tgz > $GARM_PROVIDER_NAME-linux-$arch.tgz.sha256
+    mv $GARM_PROVIDER_NAME-linux-$arch.tgz $RELEASE
+    mv $GARM_PROVIDER_NAME-linux-$arch.tgz.sha256 $RELEASE
+    popd
+done