Merge pull request #68 from elezar/update-makefile

elezar · web-flow · commit 12d87e5b86f3 · 2023-07-19T20:11:26.000+02:00
Update Makefile to align with other projects.
diff --git a/.github/workflows/pre-sanity.yml b/.github/workflows/pre-sanity.yml
@@ -0,0 +1,22 @@
+name: Run pre sanity
+
+# run this workflow for each commit
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+             
+      - name: Build dev image
+        run: make .build-image
+      
+      - name: Build
+        run: make docker-build
+
+      - name: Tests
+        run: make docker-coverage
+
+      - name: Checks
+        run: make docker-check
diff --git a/Makefile b/Makefile
@@ -12,44 +12,153 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-DOCKER ?= docker
-GOLANG_VERSION ?= 1.15
-C_FOR_GO_TAG ?= 8eeee8c3b71f9c3c90c4a73db54ed08b0bba971d
-BUILDIMAGE ?= nvidia/go-nvml-devel:$(GOLANG_VERSION)-$(C_FOR_GO_TAG)
-
 PWD := $(shell pwd)
 GEN_DIR := $(PWD)/gen
 PKG_DIR := $(PWD)/pkg
 GEN_BINDINGS_DIR := $(GEN_DIR)/nvml
 PKG_BINDINGS_DIR := $(PKG_DIR)/nvml
 
-SOURCES = $(shell find $(GEN_BINDINGS_DIR) -type f)
-
-EXAMPLES := $(patsubst ./examples/%/,%,$(sort $(dir $(wildcard ./examples/*/))))
-EXAMPLE_TARGETS := $(patsubst %,example-%, $(EXAMPLES))
-
 ifeq ($(shell uname),Darwin)
 	SED := $(DOCKER) run -it --rm -v "$(PWD):$(PWD)" -w "$(PWD)" alpine:latest sed
 else
 	SED := sed
 endif
 
-TARGETS := all test clean bindings test-bindings clean-bindings patch-nvml-h examples $(EXAMPLE_TARGETS)
-DOCKER_TARGETS := $(patsubst %, docker-%, $(TARGETS))
-.PHONY: $(TARGETS) $(DOCKER_TARGETS)
+MODULE := github.com/NVIDIA/go-nvml/pkg
 
-.DEFAULT_GOAL = all
+DOCKER ?= docker
 
-all: bindings
-test: test-bindings
-clean: clean-bindings
+GOLANG_VERSION ?= 1.18.10
+C_FOR_GO_TAG ?= 8eeee8c3b71f9c3c90c4a73db54ed08b0bba971d
+
+ifeq ($(IMAGE),)
+REGISTRY ?= nvidia
+IMAGE=$(REGISTRY)/go-nvml
+endif
+IMAGE_TAG ?= $(GOLANG_VERSION)-$(C_FOR_GO_TAG)
+BUILDIMAGE ?= $(IMAGE):$(IMAGE_TAG)-devel
+
+EXAMPLES := $(patsubst ./examples/%/,%,$(sort $(dir $(wildcard ./examples/*/))))
+EXAMPLE_TARGETS := $(patsubst %,example-%, $(EXAMPLES))
+
+CMDS := $(patsubst ./cmd/%/,%,$(sort $(dir $(wildcard ./cmd/*/))))
+CMD_TARGETS := $(patsubst %,cmd-%, $(CMDS))
+
+CHECK_TARGETS := assert-fmt vet lint
+
+MAKE_TARGETS := binary build all fmt generate test coverage check examples
+
+GENERATE_TARGETS := clean bindings test-bindings clean-bindings patch-nvml-h
+
+TARGETS := $(MAKE_TARGETS) $(EXAMPLE_TARGETS) $(CMD_TARGETS) $(GENERATE_TARGETS) $(CHECK_TARGETS)
+
+DOCKER_TARGETS := $(patsubst %,docker-%, $(TARGETS))
+.PHONY: $(TARGETS) $(DOCKER_TARGETS)
 
 GOOS := linux
 
+build:
+	GOOS=$(GOOS) go build $(MODULE)/...
+
 examples: $(EXAMPLE_TARGETS)
-$(EXAMPLE_TARGETS): example-%: bindings
+$(EXAMPLE_TARGETS): example-%:
 	GOOS=$(GOOS) go build ./examples/$(*)
 
+check: $(CHECK_TARGETS)
+
+# Apply go fmt to the codebase
+fmt:
+	go list -f '{{.Dir}}' $(MODULE)/... \
+		| xargs gofmt -s -l -w
+
+assert-fmt:
+	go list -f '{{.Dir}}' $(MODULE)/... \
+		| xargs gofmt -s -l > fmt.out
+	@if [ -s fmt.out ]; then \
+		echo "\nERROR: The following files are not formatted:\n"; \
+		cat fmt.out; \
+		rm fmt.out; \
+		exit 1; \
+	else \
+		rm fmt.out; \
+	fi
+
+generate:
+	go generate $(MODULE)/...
+
+lint:
+	# We use `go list -f '{{.Dir}}' $(MODULE)/...` to skip the `vendor` folder.
+	# One we have fixed the linting issues, we whould add -set_exit_status
+	go list -f '{{.Dir}}' $(MODULE)/... | grep -v pkg/nvml | xargs golint
+
+vet:
+	go vet $(MODULE)/...
+
+COVERAGE_FILE := coverage.out
+test: build
+	# go test -v -coverprofile=$(COVERAGE_FILE) $(MODULE)/...
+	@echo "TODO: Skipping tests for now"
+
+coverage: test
+	# cat $(COVERAGE_FILE) | grep -v "_mock.go" > $(COVERAGE_FILE).no-mocks
+	# go tool cover -func=$(COVERAGE_FILE).no-mocks
+	@echo "TODO: Skipping coverage for now"
+
+# Generate an image for containerized builds
+# Note: This image is local only
+.PHONY: .build-image .pull-build-image .push-build-image
+.build-image: docker/Dockerfile.devel
+	if [ "$(SKIP_IMAGE_BUILD)" = "" ]; then \
+		$(DOCKER) build \
+			--progress=plain \
+			--build-arg GOLANG_VERSION="$(GOLANG_VERSION)" \
+			--build-arg C_FOR_GO_TAG="$(C_FOR_GO_TAG)" \
+			--tag $(BUILDIMAGE) \
+			-f $(^) \
+			docker; \
+	fi
+
+.pull-build-image:
+	$(DOCKER) pull $(BUILDIMAGE)
+
+.push-build-image:
+	$(DOCKER) push $(BUILDIMAGE)
+
+# A target for executing make targets in a docker container
+$(DOCKER_TARGETS): docker-%: .build-image
+	@echo "Running 'make $(*)' in docker container $(BUILDIMAGE)"
+	$(DOCKER) run \
+		--rm \
+		-e GOCACHE=/tmp/.cache \
+		-v $(PWD):$(PWD) \
+		-w $(PWD) \
+		--user $$(id -u):$$(id -g) \
+		$(BUILDIMAGE) \
+			make $(*)
+
+# Start an interactive shell using the development image.
+PHONY: .shell
+.shell:
+	$(DOCKER) run \
+		--rm \
+		-ti \
+		-e GOCACHE=/tmp/.cache \
+		-v $(PWD):$(PWD) \
+		-w $(PWD) \
+		--user $$(id -u):$$(id -g) \
+		$(BUILDIMAGE)
+
+
+SOURCES = $(shell find $(GEN_BINDINGS_DIR) -type f)
+
+.DEFAULT_GOAL = bindings
+
+# In order to build the packages we need to patch the nvml.h file
+build: bindings
+
+test: test-bindings
+clean: clean-bindings
+
 $(PKG_BINDINGS_DIR):
 	mkdir -p $(@)
 
@@ -60,7 +169,6 @@ $(PKG_BINDINGS_DIR)/nvml.h: $(GEN_BINDINGS_DIR)/nvml.h | $(PKG_BINDINGS_DIR)
 	spatch --in-place --very-quiet --sp-file $(GEN_BINDINGS_DIR)/anonymous_structs.cocci $(@) > /dev/null
 
 bindings: .create-bindings .strip-autogen-comment .strip-nvml-h-linenumber
-
 .create-bindings: $(PKG_BINDINGS_DIR)/nvml.h $(SOURCES) | $(PKG_BINDINGS_DIR)
 	cp $(GEN_BINDINGS_DIR)/nvml.yml $(PKG_BINDINGS_DIR)
 	c-for-go -out $(PKG_DIR) $(PKG_BINDINGS_DIR)/nvml.yml
@@ -84,10 +192,6 @@ bindings: .create-bindings .strip-autogen-comment .strip-nvml-h-linenumber
 		| xargs $(SED) -i -E 's#$(SED_SEARCH_STRING)$$#$(SED_REPLACE_STRING)#g'
 
 test-bindings: bindings
-	cd $(PKG_BINDINGS_DIR); \
-		go test -v .; \
-	cd -> /dev/null
-
 clean-bindings:
 	rm -rf $(PKG_BINDINGS_DIR)
 	git checkout $(PKG_BINDINGS_DIR)
@@ -140,58 +244,9 @@ update-nvml-h:
 	done; \
 	echo
 
-# Generate an image for containerized builds
-# Note: This image is local only
-.build-image: Dockerfile
-	$(DOCKER) buildx build \
-		--progress=plain \
-		--build-arg GOLANG_VERSION="$(GOLANG_VERSION)" \
-		--build-arg C_FOR_GO_TAG="$(C_FOR_GO_TAG)" \
-		--tag $(BUILDIMAGE) \
-		.
-
-# A target for executing make targets in a docker container
-$(DOCKER_TARGETS): docker-%: .build-image
-	@echo "Running 'make $(*)' in docker container $(BUILDIMAGE)"
-	$(DOCKER) run \
-		--rm \
-		-e JQ=jq \
-		-e GOCACHE=/tmp/.cache \
-		-v $(PWD):$(PWD) \
-		-w $(PWD) \
-		--user $$(id -u):$$(id -g) \
-		$(BUILDIMAGE) \
-			make $(*)
-
-# A make target to set up an interactive docker environment as the current user.
-# This is useful for debugging issues in the make process in the container.
-.docker-shell: .build-image
-	$(DOCKER) run \
-		-ti \
-		--rm \
-		-e JQ=jq \
-		-e GOCACHE=/tmp/.cache \
-		-v $(PWD):$(PWD) \
-		-w $(PWD) \
-		--user $$(id -u):$$(id -g) \
-		$(BUILDIMAGE) \
-			bash
-
-# A make target to set up an interactive docker environment as root.
-# This is useful for debugging issues in dependencies or the container build process
-.docker-root-shell: .build-image
-	$(DOCKER) run \
-		-ti \
-		--rm \
-		-e JQ=jq \
-		-e GOCACHE=/tmp/.cache \
-		-v $(PWD):$(PWD) \
-		-w $(PWD) \
-		$(BUILDIMAGE) \
-			bash
-
 # Run markdownlint (https://github.com/markdownlint/markdownlint) for README.md
 # Note: Tabs are preferred for Golang code blocks
 markdownlint: MDL := $(DOCKER) run --rm -v "$(PWD):$(PWD)" -w "$(PWD)" markdownlint/markdownlint:latest
 markdownlint:
 	@$(MDL) --rules=~no-hard-tabs,~line-length README.md
+
diff --git a/docker/Dockerfile.devel b/docker/Dockerfile.devel
@@ -1,7 +1,6 @@
-FROM ubuntu:22.04
-
 ARG	TARGETARCH
 ARG GOLANG_VERSION=0.0.0
+FROM ubuntu:22.04
 
 # Use bash instead of sh
 SHELL ["/bin/bash", "-c"]
@@ -21,6 +20,16 @@ RUN apt-get update && apt-get install -y \
   && rm -rf /var/lib/apt/lists/* \
   && update-alternatives --install /usr/bin/python python /usr/bin/python3 1
 
+# Install the spatch tool for semantic patching of C code
+RUN apt-get update && apt-get install -y \
+  coccinelle \
+  && rm -rf /var/lib/apt/lists/*
+
+
+ARG	TARGETARCH=amd64
+ARG GOLANG_VERSION=0.0.0
+ENV GOLANG_VERSION=${GOLANG_VERSION}
+
 # Install golang
 ENV ARCH=${TARGETARCH}
 RUN ARCH=${ARCH/x86_64/amd64} && ARCH=${ARCH/aarch64/arm64} && \
@@ -31,14 +40,13 @@ ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
 
 # Get the supported version of c-for-go. Here we force the use of `GO111MODULE` for go get
 # to support the @VERSION syntax.
-ARG C_FOR_GO_TAG=master
-RUN GO111MODULE=on go get github.com/xlab/c-for-go@${C_FOR_GO_TAG}
+ARG C_FOR_GO_TAG=main
+RUN go install github.com/xlab/c-for-go@${C_FOR_GO_TAG}
+RUN go install golang.org/x/lint/golint@latest
 
 # Set the permissions on the go module path to ensure that this is accessible from
 # our user containers.
 RUN chmod -R a+rx /go/pkg/mod
 
-# Install the spatch tool for semantic patching of C code
-RUN apt-get update && apt-get install -y \
-  coccinelle \
-  && rm -rf /var/lib/apt/lists/*
+ENV JQ=jq
+
diff --git a/pkg/dl/dl.go b/pkg/dl/dl.go
@@ -25,27 +25,27 @@ import (
 import "C"
 
 const (
-	RTLD_LAZY = C.RTLD_LAZY
-	RTLD_NOW = C.RTLD_NOW
-	RTLD_GLOBAL = C.RTLD_GLOBAL
-	RTLD_LOCAL = C.RTLD_LOCAL
+	RTLD_LAZY     = C.RTLD_LAZY
+	RTLD_NOW      = C.RTLD_NOW
+	RTLD_GLOBAL   = C.RTLD_GLOBAL
+	RTLD_LOCAL    = C.RTLD_LOCAL
 	RTLD_NODELETE = C.RTLD_NODELETE
-	RTLD_NOLOAD = C.RTLD_NOLOAD
+	RTLD_NOLOAD   = C.RTLD_NOLOAD
 	RTLD_DEEPBIND = C.RTLD_DEEPBIND
 )
 
-type DynamicLibrary struct{
-	Name string
-	Flags int
+type DynamicLibrary struct {
+	Name   string
+	Flags  int
 	handle unsafe.Pointer
 }
 
 func New(name string, flags int) *DynamicLibrary {
 	return &DynamicLibrary{
-		Name: name,
-		Flags: flags,
+		Name:   name,
+		Flags:  flags,
 		handle: nil,
-    }
+	}
 }
 
 func (dl *DynamicLibrary) Open() error {
