Merge pull request #3 from jpnt/alpha

Alpha

Author: jpnt

.github/workflows/cicd.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        architecture: [amd64, arm64, 386, riscv64]  
+        architecture: [amd64, 386, arm64, arm, riscv64, mips, mips64, mips64le, mipsle, ppc64, ppc64le, s390x]  
 
     steps:
       - name: Checkout code
@@ -27,14 +27,15 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: '1.23'
+          go-version: '1.24.1'
 
       - name: Run tests
         run: go test -v ./...
 
       - name: Build
         run: |
-          GOARCH=${{ matrix.architecture }} GOOS=linux go build -ldflags="-s -w" -v -o kman-${{ matrix.architecture }} ./cmd/kman/kman.go
+          VERSION=$(echo "${GITHUB_REF#refs/tags/v}" )
+          GOARCH=${{ matrix.architecture }} GOOS=linux go build -ldflags="-s -w" -v -o kman-${{ matrix.architecture }}-${VERSION} ./cmd/kman/
 
       - name: Display structure of files
         run: ls -lRha

README.md

@@ -22,7 +22,7 @@ chmod +x kman-amd64
 4. Verify installation
 
 ```sh
-kman -version
+kman --version
 ```
 
 ### Via Go get (for go devs)
@@ -41,7 +41,9 @@ go build -o kman ./cmd/kman
 kman --version
 ```
 
-## Examples
+## kman CLI Usage Examples
+
+TODO
 
 - Run everything (download, compile, install, etc)
 
@@ -81,17 +83,15 @@ $ kman install,bootloader,initramfs --dir=./kernel-6.9.9 --initramfs=booster
 
 ## Pipeline Steps
 
-Each step in the pipeline can be executed indidually, but requires some parameter/s.
-
-- Download (url)
-- Verify (archive)
-- Extract (archive)
-- Patch (optional: directory)
-- Configure (optional: .config file, directory, njobs)
-- Compile (optional: directory)
-- Install (optional: directory)
-- Initramfs (optional: initramfs)
-- Bootloader (optional: bootloader)
+- Download
+- Verify
+- Extract
+- Patch
+- Configure
+- Compile
+- Install
+- Initramfs
+- Bootloader
 
 ### Architecture
 

go.mod

@@ -1,3 +1,3 @@
 module github.com/jpnt/kman
 
-go 1.23.0
+go 1.24.1

internal/core/context.go

@@ -16,9 +16,9 @@ type KernelContext struct {
 	SignatureURL  string
 	ConfigOptions []string
 	OldConfigPath string
-	NumJobs       string
 	Initramfs     string
 	Bootloader    string
+	NumJobs       int
 }
 
 var _ IKernelContext = (*KernelContext)(nil)

internal/core/pipeline.go

@@ -21,20 +21,22 @@ type Pipeline struct {
 var _ IPipeline = (*Pipeline)(nil)
 
 func (pl *Pipeline) Run() error {
-	if len(pl.steps) == 0 {
+	numSteps := len(pl.steps)
+	var stepNames []string
+
+	if numSteps == 0 {
 		return fmt.Errorf("no steps were configured")
 	}
 
-	pl.log.Info("The following steps will be executed:")
 	for _, step := range pl.steps {
-		pl.log.Info("- %s", step.Name())
+		stepNames = append(stepNames, step.Name())
 	}
 
-	pl.log.Info("Starting execution ...")
+	pl.log.Info("Executing %d steps: %v", numSteps, stepNames)
 
-	for _, step := range pl.steps {
+	for i, step := range pl.steps {
 		start := time.Now()
-		pl.log.Info("==> Starting step: %s ...", step.Name())
+		pl.log.Info("==> Starting step [%d/%d]: %s", i+1, numSteps, step.Name())
 
 		if err := pl.ctx.Validate(step.Name()); err != nil {
 			return fmt.Errorf("validation failed for step %q: %w", step.Name(), err)
@@ -45,7 +47,7 @@ func (pl *Pipeline) Run() error {
 		}
 
 		duration := time.Since(start)
-		pl.log.Info("<== Completed step: %s in %s", step.Name(), duration)
+		pl.log.Info("<== Completed step [%d/%d]: %s in %s", i+1, numSteps, step.Name(), duration)
 	}
 	return nil
 }

internal/core/pipeline_builder.go

@@ -29,7 +29,7 @@ func NewPipelineBuilder(l logger.ILogger, f IStepFactory, c IKernelContext) IPip
 func (b *PipelineBuilder) WithStep(stepName string) IPipelineBuilder {
 	step, err := b.factory.CreateStep(stepName, b.logger, b.ctx)
 	if err != nil {
-		b.logger.Warn("Failed to create step %s: %s", stepName, err)
+		b.logger.Warn("Could not create step %q: %s", stepName, err)
 		return b
 	}
 	b.steps = append(b.steps, step)

internal/service/compile.go

@@ -1,19 +1,17 @@
 package service
 
 import (
-	// "errors"
 	"fmt"
 	"os"
 	"os/exec"
 
 	"github.com/jpnt/kman/internal/core"
 	"github.com/jpnt/kman/pkg/logger"
-	// "github.com/jpnt/kman/pkg/utils"
 )
 
 type CompileStep struct {
 	log *logger.Logger
-	ctx    *core.KernelContext
+	ctx *core.KernelContext
 }
 
 var _ core.IStep = (*CompileStep)(nil)
@@ -22,24 +20,25 @@ func (s *CompileStep) Name() string {
 	return "compile"
 }
 
-// TODO
 func (s *CompileStep) Execute() error {
 	dir := s.ctx.Directory
-	// njobs := s.ctx.njobs // TODO
-	njobs := 1
-	njobsStr := fmt.Sprintf("-j%d", njobs)
 
-	s.log.Info("Compiling Linux kernel: 'make -C %s %s' ...", dir, njobsStr)
+	if s.ctx.NumJobs == 0 {
+		defaultNumJobs := 1
+		s.log.Warn("Number of jobs not configured, defaulting to %d", defaultNumJobs)
+		s.ctx.NumJobs = defaultNumJobs
+	}
+
+	numJobsStr := fmt.Sprintf("-j%d", s.ctx.NumJobs)
+
+	s.log.Info("Compiling Linux kernel using 'make -C %s %s' ...", dir, numJobsStr)
 
-	cmd := exec.Command("make", "-C", dir, njobsStr)
+	cmd := exec.Command("make", "-C", dir, numJobsStr)
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 
 	if err := cmd.Run(); err != nil {
 		return fmt.Errorf("kernel compilation failed: %w", err)
 	}
-
-	s.log.Info("Compiled Linux kernel")
-
 	return nil
 }

internal/service/configure.go

@@ -19,53 +19,44 @@ type ConfigureStep struct {
 
 var _ core.IStep = (*ConfigureStep)(nil)
 
-var defaultOptions = []string{"defconfig"}
-var validOptions = []string{"defconfig", "menuconfig", "nconfig", "oldconfig"}
-
 func (s *ConfigureStep) Name() string {
 	return "configure"
 }
 
 func (s *ConfigureStep) Execute() error {
 	if s.ctx.ConfigOptions == nil {
-		s.log.Info("No config options were detected, setting up default options ...")
-		s.ctx.ConfigOptions = defaultOptions
-	}
-
-	// TODO: better option than doing this
-	configOptions := s.ctx.ConfigOptions
-	for _, opt := range configOptions {
-		if !isValidOption(opt) {
-			return fmt.Errorf("invalid configuration option: %s", opt)
-		}
+		defaultConfigOptions := []string{"tinyconfig"}
+		s.log.Warn("Kernel config options not provided, defaulting to %s", defaultConfigOptions)
+		s.ctx.ConfigOptions = defaultConfigOptions
 	}
 
 	if err := s.copyOldConfig(); err != nil {
 		return fmt.Errorf("failed to copy .config: %w", err)
 	}
 
-	s.log.Info("Configuring Linux kernel with: %v ...", configOptions)
-
 	dir := s.ctx.Directory
 	if err := os.Chdir(dir); err != nil {
-		return fmt.Errorf("failed to change directory to %s: %w", dir, err)
+		return fmt.Errorf("failed to change directory to %q: %w", dir, err)
 	}
 
-	for _, opt := range configOptions {
-		cmd := exec.Command("make", opt)
+	for _, option := range s.ctx.ConfigOptions {
+		s.log.Info("Configuring Linux kernel with: 'make %s' ...", option)
+
+		cmd := exec.Command("make", option)
 		cmd.Stdout = os.Stdout
 		cmd.Stderr = os.Stderr
 
 		if err := cmd.Run(); err != nil {
 			return fmt.Errorf("kernel configuration failed: %w", err)
 		}
 	}
+
 	return nil
 }
 
 func (s *ConfigureStep) copyOldConfig() error {
 	if s.ctx.OldConfigPath == "" {
-		s.log.Warn("Skipping copy of old .config file")
+		s.log.Warn("Old .config path not provided, skipping ...")
 		return nil
 	}
 
@@ -84,12 +75,3 @@ func (s *ConfigureStep) copyOldConfig() error {
 	}
 	return nil
 }
-
-func isValidOption(option string) bool {
-	for _, validOption := range validOptions {
-		if option == validOption {
-			return true
-		}
-	}
-	return false
-}

internal/service/download.go

@@ -28,8 +28,7 @@ func (s *DownloadStep) Execute() error {
 		return err
 	}
 
-	s.log.Info("Downloaded Linux kernel tarball to: %s", kernelPath)
 	s.ctx.ArchivePath = kernelPath
-
+	s.log.Info("Downloaded Linux kernel tarball to: %s", kernelPath)
 	return nil
 }

internal/service/extract.go

@@ -12,7 +12,7 @@ import (
 
 type ExtractStep struct {
 	log *logger.Logger
-	ctx    *core.KernelContext
+	ctx *core.KernelContext
 }
 
 // Ensure struct implements interface