Merge pull request #1 from koyeb/cleanup

Prepare for OSS

Author: Charly Molter

.github/workflows/prb.yaml

@@ -0,0 +1,11 @@
+on: [pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "1.16"
+      - run: make check

.github/workflows/release.yaml

@@ -0,0 +1,12 @@
+on:
+  release:
+    types: [created]
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: "1.16"
+      - run: make check

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+Feel free to open PRs. There isn't a formal process yet.

LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2021 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,15 @@
+tidy:
+	test "${CI}" || go mod tidy
+
+fmt:
+	test "${CI}" || gofmt -s -w .
+	test "${CI}" == "" || test -z "`gofmt -d . | tee /dev/stderr`"
+
+vet:
+	go vet ./...
+
+test:
+	go test -v ./...
+
+check: tidy fmt vet test
+

README.md

@@ -25,3 +25,6 @@ It's therefore necessary to make execution of the reconciler as observable as po
 At Koyeb we've built reconcilers that helps keeping our models in sync with [Hashicorp Nomad](https://www.nomadproject.io/) and [Kuma](kuma.io/).
 
 
+## Contributing
+
+See [Contributing](CONTRIBUTING.md).

pkg/reconciler/api.go

@@ -28,7 +28,7 @@ type Config struct {
 	// MaxReconcileTime the maximum time a handle of an item should take
 	MaxReconcileTime time.Duration
 	// Observability configuration for logs, metrics and traces
-	Observability    Observability
+	Observability Observability
 }
 
 func DefaultConfig() Config {
@@ -53,6 +53,7 @@ type Handler interface {
 
 // HandlerFunc see Handler
 type HandlerFunc func(ctx context.Context, id string) Result
+
 func (f HandlerFunc) Handle(ctx context.Context, id string) Result {
 	return f(ctx, id)
 }
@@ -84,7 +85,6 @@ type Error interface {
 	RetryDelay() time.Duration
 }
 
-
 // WorkerHasher specifies which of the control-loop workers should handle this specific item.
 type WorkerHasher interface {
 	// Route decide on which worker this item will go (return a value < 0 to drop this item), count is the number of items
@@ -93,6 +93,7 @@ type WorkerHasher interface {
 
 // WorkerHasherFunc see WorkerHasher
 type WorkerHasherFunc func(ctx context.Context, id string, count int) (int, error)
+
 func (f WorkerHasherFunc) Route(ctx context.Context, id string, count int) (int, error) {
 	return f(ctx, id, count)
 }
@@ -114,6 +115,7 @@ type EventHandler interface {
 
 // EventHandlerFunc see EventHandler
 type EventHandlerFunc func(ctx context.Context, jobId string) error
+
 func (f EventHandlerFunc) Handle(ctx context.Context, jobId string) error {
 	return f(ctx, jobId)
 }
@@ -145,6 +147,7 @@ type EventStream interface {
 
 // EventStreamFunc see EventStream
 type EventStreamFunc func(ctx context.Context, handler EventHandler) error
+
 func (f EventStreamFunc) Subscribe(ctx context.Context, handler EventHandler) error {
 	return f(ctx, handler)
 }

pkg/reconciler/observability.go

@@ -13,6 +13,7 @@ type Observability struct {
 	metric.Meter
 	trace.Tracer
 }
+
 var DefaultObservability = NewObservability(NoopLogger{}, otel.GetMeterProvider(), otel.GetTracerProvider())
 
 // LoggerWithCtx add the tracing context to the logger
@@ -25,7 +26,6 @@ func NewObservability(l Logger, m metric.MeterProvider, t trace.TracerProvider)
 	return Observability{Logger: l, Meter: m.Meter("kreconciler"), Tracer: t.Tracer("kreconciler")}
 }
 
-
 type Logger interface {
 	With(keyValues ...interface{}) Logger
 	Debug(msg string, keyValues ...interface{})
@@ -34,7 +34,8 @@ type Logger interface {
 	Error(msg string, keyValues ...interface{})
 }
 
-type NoopLogger struct {}
+type NoopLogger struct{}
+
 func (n NoopLogger) With(keyValues ...interface{}) Logger {
 	return n
 }
@@ -50,4 +51,3 @@ func (n NoopLogger) Warn(msg string, keyValues ...interface{}) {
 
 func (n NoopLogger) Error(msg string, keyValues ...interface{}) {
 }
-

pkg/reconciler/observability_test.go

@@ -26,13 +26,13 @@ func (o obsTest) SpanRecorder() *oteltest.StandardSpanRecorder {
 func (o obsTest) Observability() Observability {
 	return Observability{
 		Logger: o.log,
-		Meter:         o.contr.MeterProvider().Meter("test"),
-		Tracer:        oteltest.NewTracerProvider(oteltest.WithSpanRecorder(o.sr)).Tracer("test"),
+		Meter:  o.contr.MeterProvider().Meter("test"),
+		Tracer: oteltest.NewTracerProvider(oteltest.WithSpanRecorder(o.sr)).Tracer("test"),
 	}
 }
 
 type testLog struct {
-	t *testing.T
+	t    *testing.T
 	args []string
 }
 
@@ -41,12 +41,12 @@ func (l testLog) With(kv ...interface{}) Logger {
 	for _, v := range l.args {
 		args = append(args, v)
 	}
-	for i := 0; i < len(kv); i+=2 {
+	for i := 0; i < len(kv); i += 2 {
 		args = append(args, fmt.Sprintf("%s=%v", kv[i], kv[i+1]))
 	}
 
 	return testLog{
-		t: l.t,
+		t:    l.t,
 		args: args,
 	}
 }