go-experiments

README

go-experiments

Overview:

• signals.go
• uuid.go
• Dockerfile.TEMPLATE

signals.go

The Go code demonstrates how to manage context and system signals in a concurrent application. It shows how to initiate, monitor, and gracefully shut down long-running tasks using context and signal handling. At its core, it consists of three main routines: main, handleSignals, and doSomething.

1. The main function sets up a cancellable context and initiates the other two routines as goroutines.
2. handleSignals listens for system signals like SIGTERM and SIGINT to gracefully shut down the application by cancelling the context.
3. doSomething simulates a long-running task that can be interrupted based on the context's state.

Core Functionalities:

1. Context Management:

   • Creates a cancellable context to manage the lifecycle of goroutines.
   • Example: ctx, cancel := context.WithCancel(context.Background())

2. Signal Handling:

   • Listens for system signals like SIGTERM and SIGINT and cancels the context when received.
   • Example: signal.Notify(c, os.Interrupt, syscall.SIGTERM)

3. Concurrent Execution:

   • Uses goroutines to run functions concurrently.
   • Manages goroutines using a WaitGroup.
   • Example: go doSomething(ctx, &wg)

4. Graceful Shutdown:

   • Waits for all goroutines to finish before exiting the program.
   • Example: wg.Wait()

5. Logging:

   • Provides a logging function to print time-stamped messages.
   • Example: log("Hello 👋", "main")

6. Resource Cleanup:

   • Uses defer to ensure that resources like context are properly released.
   • Example: defer cancel()

Use-Case Example:

This code would be applicable in a server application where you have multiple long-running tasks that need to be managed and could be interrupted by system signals. For instance, a web scraper that runs multiple scraping tasks in parallel but needs to shut down gracefully when receiving a termination signal.

uuid.go

The Go code snippet is designed to showcase the generation of unique identifiers (UUIDs) using various third-party libraries. It aims to demonstrate the differences in UUID formats and configurations provided by these libraries.

Core Functionalities:

1. Multiple Library Support:

   • Imports multiple third-party libraries specialized in generating UUIDs.
   • Example: gouid, ulid, nanoid, and goid.

2. Formatted Output:

   • Utilizes a helper function print to display the UUIDs in a tabular format.
   • Example: print("lib", "config", "uuid")

3. UUID Generation:

   • Generates UUIDs using different configurations and libraries.
   • Example: gouid.String(16, gouid.LowerCaseAlphaNum) generates a 16-character UUID consisting of lowercase alphabets and numbers.

4. Showcase Function:

   • Central function that orchestrates the UUID generation and output display.
   • Calls the print function to display each UUID along with its generating library and configuration.

5. Error Handling:

   • Although not explicitly shown, libraries like nanoid return errors that can be handled. The current code ignores these errors.
   • Example: nid, _ := nanoid.New()

Use-Case Example:

This code would be useful in a scenario where you need to evaluate different UUID generation libraries for your project. For instance, if you're building a distributed system where each node or transaction requires a unique identifier, you could run this code to see which library produces UUIDs that best fit your requirements.

dynamodb.go

Requirement (env)

# export $(grep -v '^#' secrets_dynamodb.env | xargs)
AWS_ACCESS_KEY_ID=XXXXX
AWS_SECRET_ACCESS_KEY=XXXXX
AWS_REGION=eu-central-1
TABLENAME=go-experiments-dynamodb

Dockerfile.TEMPLATE

The Dockerfile is designed to build a secure and optimized containerized Go application. It employs a multi-stage build process to separate the build environment from the runtime environment, enhancing security and reducing the final image size.

Core Functionalities:

1. Multi-Stage Build:

   • Utilizes two stages: builder for building the Go application and FINAL_IMAGE for the runtime.
   • Example: FROM ${BUILD_IMAGE} AS builder and FROM ${FINAL_IMAGE}

2. Argument Definitions:

   • Defines build arguments for base images and source directory.
   • Example: ARG BUILD_IMAGE=golang:1.21@sha256:...

3. Dependency Management:

   • Copies go.mod and go.sum files and downloads dependencies.
   • Caches dependencies unless go.mod or go.sum changes.
   • Example: COPY go.mod go.sum ./ and RUN go mod download && go mod verify

4. Source Code Copy:

   • Copies the entire source code into the container.
   • Example: COPY . .

5. Optimized Compilation:

   • Compiles the Go application with flags for optimization and static linking.
   • Example: RUN GOOS=linux GOARCH=amd64 go build -ldflags='-w -s -extldflags "-static"' -a -v -o /app ./cmd/signals/signals.go

6. Security Measures:

   • Uses a distroless image for the final stage.
   • Runs the application as a non-root user.
   • Example: USER nobody:nobody and CMD ["app"]

Use-Case Example:

This Dockerfile template would be particularly useful for deploying Go applications in a Kubernetes cluster where security and optimization are critical. The multi-stage build ensures that only the necessary components are included in the final image, and running as a non-root user adds an extra layer of security.