Spring cleaning

codecov.yml → .github/codecov.yml

@@ -2,20 +2,14 @@
 coverage:
   precision: 0 # xx%
   round: down # round down
-  range: 39..75 # red -> yellow (this range) -> green
+  range: 30..40 # red < yellow (this range) < green
 
   status:
     project:
       default:
-        against: auto # auto compares coverage to the previous base commit
         target: auto # automatically calculate coverage target - should increase
         threshold: 2% # allow for 2% reduction without failing
     patch:
       default:
-        against: parent
         target: auto
     changes: false
-
-ignore:
-  - "vendor"
-  - "ipxe/"

.github/workflows/ci-checks.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env nix-shell
+#!nix-shell -i bash ../../shell.nix
+# shellcheck shell=bash
+
+set -eux
+
+failed=0
+
+# --check doesn't show what line number fails, so write the result to disk for the diff to catch
+if ! git ls-files '*.json' '*.md' '*.yaml' '*.yml' | xargs prettier --list-different --write; then
+	failed=1
+fi
+
+if ! shfmt -f . | xargs shfmt -l -d; then
+	failed=1
+fi
+
+if ! shfmt -f . | xargs shellcheck; then
+	failed=1
+fi
+
+if ! nixfmt shell.nix; then
+	failed=1
+fi
+
+if ! git ls-files '*.go' | xargs -I% sh -c 'sed "/^import (/,/^)/ { /^\s*$/ d }" % >%.tmp && goimports -w %.tmp && (if cmp -s % %.tmp; then rm %.tmp; else mv %.tmp %; fi)'; then
+	failed=1
+fi
+
+if ! go mod tidy; then
+	failed=true
+fi
+
+if ! git diff | (! grep .); then
+	failed=1
+fi
+
+exit "$failed"

.github/workflows/ci.yaml

@@ -9,59 +9,56 @@ on:
 
 jobs:
   validation:
-    runs-on: [self-hosted, X64]
+    runs-on: ubuntu-latest
     env:
       CGO_ENABLED: 0
     steps:
       - name: Setup Dynamic Env
         run: |
           echo "MAKEFLAGS=-j$(nproc)" | tee $GITHUB_ENV
+
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           lfs: true
+
       - name: Install nix
-        uses: cachix/install-nix-action@018abf956a0a15673dae4932ae26f0f071ac0944
+        uses: cachix/install-nix-action@v17
         with:
           nix_path: nixpkgs=channel:nixpkgs-unstable
+
+      - name: Fetch Deps
+        run: nix-shell --run 'go get -t ./... && go mod tidy'
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
-      - name: Non Go formatters and linters
-        run: ./.github/workflows/ci-non-go.sh
-      - name: Install Go
-        uses: actions/setup-go@v2
-        with:
-          go-version: "1.18"
+
       - name: Generate all files
-        run: nix-shell --run 'make gen'
-      - name: goimports
-        run: go get golang.org/x/tools/cmd/goimports && goimports -d . | (! grep .)
-      - name: go vet
-        run: go mod tidy && go vet ./...
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
-        with:
-          args: -v
-      - name: go test
-        run: go test -v ./... -gcflags=-l
-      - name: go test coverage
-        run: go test -coverprofile=coverage.txt ./... -gcflags=-l
+        run: nix-shell --run 'make -j1 gen'
+
+      - name: Run all the tests
+        run: nix-shell --run 'make ci'
+
       - name: upload codecov
         run: bash <(curl -s https://codecov.io/bash)
+
       - name: compile binaries
         run: nix-shell --run 'make crosscompile'
+
       - name: Docker Image Tag for Sha
         id: docker-image-tag
         run: |
           echo ::set-output name=tags::quay.io/tinkerbell/boots:latest,quay.io/tinkerbell/boots:sha-${GITHUB_SHA::8}
+
       - name: Login to quay.io
         uses: docker/login-action@v1
         if: ${{ startsWith(github.ref, 'refs/heads/main') }}
         with:
           registry: quay.io
           username: ${{ secrets.QUAY_USERNAME }}
           password: ${{ secrets.QUAY_PASSWORD }}
-      - name: quay.io/tinkerbell/boots
+
+      - name: Build Docker Images
         uses: docker/build-push-action@v2
         with:
           context: ./

.gitignore

@@ -6,11 +6,3 @@
 /cmd/boots/boots
 /cmd/boots/boots-*-*
 coverage.txt
-!deploy/stack/.env
-.vagrant
-deploy/stack/state/webroot/misc/osie/current/*
-deploy/stack/state/webroot/workflow/*
-!deploy/stack/state/webroot/misc/osie/current/.keep
-!deploy/stack/state/webroot/workflow/.keep
-deploy/stack/state/webroot/*.gz
-workflow_id.txt

Makefile

@@ -5,9 +5,11 @@ all: help
 boots: cmd/boots/boots ## Compile boots for host OS and Architecture
 
 crosscompile: $(crossbinaries) ## Compile boots for all architectures
-	
+
 gen: $(generated_go_files) ## Generate go generate'd files
 
+tools: $(toolsBins) ## Builds cli tools defined in tools.go
+
 IMAGE_TAG ?= boots:latest
 image: cmd/boots/boots-linux-amd64 ## Build docker image
 	docker build -t $(IMAGE_TAG) .
@@ -27,15 +29,16 @@ coverage: test ## Show test coverage
 vet: ## Run go vet
 	go vet ./...
 
-goimports: ## Run goimports
-	@echo be sure goimports is installed
+goimports: bin/goimports gen ## Run goimports
 	goimports -w .
 
-golangci-lint: ## Run golangci-lint
-	@echo be sure golangci-lint is installed: https://golangci-lint.run/usage/install/
+golangci-lint: bin/golangci-lint gen ## Run golangci-lint
 	golangci-lint run -v
 
-validate-local: vet coverage goimports golangci-lint ## Runs all the same validations and tests that run in CI
+ci-checks: bin/goimports .github/workflows/ci-checks.sh shell.nix gen
+	./.github/workflows/ci-checks.sh
+
+ci: ci-checks coverage goimports golangci-lint vet ## Runs all the same validations and tests that run in CI
 
 help: ## Print this help
 	@grep --no-filename -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sed 's/:.*##/·/' | sort | column -ts '·' -c 120

cmd/boots/http.go

@@ -20,7 +20,7 @@ import (
 	"github.com/tinkerbell/boots/client"
 	"github.com/tinkerbell/boots/conf"
 	"github.com/tinkerbell/boots/httplog"
-	"github.com/tinkerbell/boots/installers/coreos"
+	"github.com/tinkerbell/boots/installers/flatcar"
 	"github.com/tinkerbell/boots/installers/vmware"
 	"github.com/tinkerbell/boots/job"
 	"github.com/tinkerbell/boots/metrics"
@@ -99,10 +99,8 @@ func (s *BootsHTTPServer) ServeHTTP(i job.Installers, addr string, ipxePattern s
 	}))
 
 	var httpHandlers = make(map[string]http.HandlerFunc)
-	// register coreos/flatcar endpoints
-	httpHandlers[coreos.IgnitionPathCoreos] = coreos.ServeIgnitionConfig("coreos", s.jobManager)
-	httpHandlers[coreos.IgnitionPathFlatcar] = coreos.ServeIgnitionConfig("flatcar", s.jobManager)
-	httpHandlers[coreos.OEMPath] = coreos.ServeOEM(s.jobManager)
+	// register flatcar endpoints
+	httpHandlers[flatcar.IgnitionPathFlatcar] = flatcar.ServeIgnitionConfig(s.jobManager)
 	// register vmware endpoints
 	httpHandlers[vmware.KickstartPath] = vmware.ServeKickstart(s.jobManager)
 

cmd/boots/main.go

@@ -31,11 +31,9 @@ import (
 	"github.com/tinkerbell/boots/dhcp"
 	"github.com/tinkerbell/boots/httplog"
 	"github.com/tinkerbell/boots/installers"
-	"github.com/tinkerbell/boots/installers/coreos"
 	"github.com/tinkerbell/boots/installers/custom_ipxe"
-	"github.com/tinkerbell/boots/installers/nixos"
+	"github.com/tinkerbell/boots/installers/flatcar"
 	"github.com/tinkerbell/boots/installers/osie"
-	"github.com/tinkerbell/boots/installers/rancher"
 	"github.com/tinkerbell/boots/installers/vmware"
 	"github.com/tinkerbell/boots/job"
 	"github.com/tinkerbell/boots/metrics"
@@ -206,8 +204,13 @@ func main() {
 
 	mainlog.With("addr", cfg.dhcpAddr).Info("serving dhcp")
 	go dhcpServer.ServeDHCP(cfg.dhcpAddr, nextServer, ipxeBaseURL, bootsBaseURL)
+
+	installers, err := cfg.registerInstallers()
+	if err != nil {
+		mainlog.Fatal(err)
+	}
 	mainlog.With("addr", cfg.httpAddr).Info("serving http")
-	go httpServer.ServeHTTP(cfg.registerInstallers(), cfg.httpAddr, ipxePattern, ipxeHandler)
+	go httpServer.ServeHTTP(installers, cfg.httpAddr, ipxePattern, ipxeHandler)
 
 	<-ctx.Done()
 	mainlog.Info("boots shutting down")
@@ -360,41 +363,50 @@ func newCLI(cfg *config, fs *flag.FlagSet) *ffcli.Command {
 	}
 }
 
-func (cf *config) registerInstallers() job.Installers {
+func (cf *config) registerInstallers() (job.Installers, error) {
 	// register installers
 	i := job.NewInstallers()
-	// register coreos/flatcar
-	c := coreos.Installer{}
-	i.RegisterDistro("coreos", c.BootScript())
-	i.RegisterDistro("flatcar", c.BootScript())
+
+	// register flatcar
+	o := flatcar.Installer()
+	i.RegisterDistro("flatcar", o.BootScript("flatcar"))
+
 	// register custom ipxe
-	ci := custom_ipxe.Installer{}
-	i.RegisterDistro("custom_ipxe", ci.BootScript())
-	i.RegisterInstaller("custom_ipxe", ci.BootScript())
-	// register nixos
-	n := nixos.Installer{Paths: nixos.BuildInitPaths()}
-	i.RegisterDistro("nixos", n.BootScript())
+	o = custom_ipxe.Installer()
+	i.RegisterDistro("custom_ipxe", o.BootScript("custom_ipxe"))
+	i.RegisterInstaller("custom_ipxe", o.BootScript("custom_ipxe"))
+
+	dataModelVersion := env.Get("DATA_MODEL_VERSION")
+	auth := env.Get("TINKERBELL_GRPC_AUTHORITY")
+	if dataModelVersion == "1" && auth == "" {
+		return job.Installers{}, errors.New("TINKERBELL_GRPC_AUTHORITY is required when in tinkerbell mode")
+	}
+
 	// register osie
-	o := osie.Installer{}
-	i.RegisterDistro("discovery", o.Discover())
-	// register osie as default
-	d := osie.Installer{ExtraKernelArgs: cf.extraKernelArgs}
-	i.RegisterDefaultInstaller(d.DefaultHandler())
-	// register rancher
-	r := rancher.Installer{}
-	i.RegisterDistro("rancher", r.BootScript())
+	o = osie.Installer(
+		dataModelVersion,
+		auth,
+		cf.extraKernelArgs,
+		env.Get("DOCKER_REGISTRY"),
+		env.Get("REGISTRY_USERNAME"),
+		env.Get("REGISTRY_PASSWORD"),
+		env.Bool("TINKERBELL_TLS", true),
+	)
+	i.RegisterDistro("discovery", o.BootScript("discover"))
+	i.RegisterDefaultInstaller(o.BootScript("default"))
+
 	// register vmware
-	v := vmware.Installer{}
-	i.RegisterSlug("vmware_esxi_5_5", v.BootScriptVmwareEsxi55())
-	i.RegisterSlug("vmware_esxi_6_0", v.BootScriptVmwareEsxi60())
-	i.RegisterSlug("vmware_esxi_6_5", v.BootScriptVmwareEsxi65())
-	i.RegisterSlug("vmware_esxi_6_7", v.BootScriptVmwareEsxi67())
-	i.RegisterSlug("vmware_esxi_7_0", v.BootScriptVmwareEsxi70())
-	i.RegisterSlug("vmware_esxi_7_0U2a", v.BootScriptVmwareEsxi70U2a())
-	i.RegisterSlug("vmware_esxi_6_5_vcf", v.BootScriptVmwareEsxi65())
-	i.RegisterSlug("vmware_esxi_6_7_vcf", v.BootScriptVmwareEsxi67())
-	i.RegisterSlug("vmware_esxi_7_0_vcf", v.BootScriptVmwareEsxi70())
-	i.RegisterDistro("vmware", v.BootScriptDefault())
-
-	return i
+	v := vmware.Installer()
+	i.RegisterSlug("vmware_esxi_5_5", v.BootScript("vmware_esxi_5_5"))
+	i.RegisterSlug("vmware_esxi_6_0", v.BootScript("vmware_esxi_6_0"))
+	i.RegisterSlug("vmware_esxi_6_5", v.BootScript("vmware_esxi_6_5"))
+	i.RegisterSlug("vmware_esxi_6_7", v.BootScript("vmware_esxi_6_7"))
+	i.RegisterSlug("vmware_esxi_7_0", v.BootScript("vmware_esxi_7_0"))
+	i.RegisterSlug("vmware_esxi_7_0U2a", v.BootScript("vmware_esxi_7_0U2a"))
+	i.RegisterSlug("vmware_esxi_6_5_vcf", v.BootScript("vmware_esxi_6_5_vcf"))
+	i.RegisterSlug("vmware_esxi_6_7_vcf", v.BootScript("vmware_esxi_6_7_vcf"))
+	i.RegisterSlug("vmware_esxi_7_0_vcf", v.BootScript("vmware_esxi_7_0_vcf"))
+	i.RegisterDistro("vmware", v.BootScript("vmware"))
+
+	return i, nil
 }