From a9e265a4f312e8fb104b13225a0a375629225ce2 Mon Sep 17 00:00:00 2001
From: froge <froge@git.repo.cafe>
Date: Wed, 12 Feb 2025 11:55:56 +1000
Subject: [PATCH] Add dockerfile, update ping route to alive route, add
 documentation

---
 Dockerfile     | 21 +++++++++++++++++++++
 README.md      | 26 ++++++++++++++++++++++++++
 go.mod         |  4 ++--
 main.go        |  7 ++-----
 routes.go      |  4 ++--
 routes_test.go |  8 ++++----
 6 files changed, 57 insertions(+), 13 deletions(-)
 create mode 100644 Dockerfile

diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..c130c27
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,21 @@
+# syntax=docker/dockerfile:1
+FROM docker.io/golang:1.23
+
+# Create working directory and grab deps
+WORKDIR /usr/src/gomusic
+COPY go.mod go.sum ./
+RUN go mod download
+
+# Copy the source code. Note the slash at the end, as explained in
+# https://docs.docker.com/engine/reference/builder/#copy
+COPY *.go ./
+
+# Build
+# Note that our dependencies require CGO
+RUN CGO_ENABLED=1 GOOS=linux go build -v -o /usr/local/bin/gomusic
+
+# Signal which ports we use
+EXPOSE 8000
+
+# Run
+CMD ["gomusic"]
diff --git a/README.md b/README.md
index 0389c24..a8e6ec5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
 # Basic spotify API in golang
 This API supports simple artist read operations for spotify data, as well as using a simple caching database and handling client authentication automatically.
+
+## Setup
+After compiling the binary, or when executing via `go run`, just be sure to set the following environment variables to enable access to Spotify's API
+```
+SPOTIFY_ID=<your spotify client ID>
+SPOTIFY_TOKEN=<your spotify token>
+```
+
+Example execution using the linux command line:
+`SPOTIFY_ID=myspotifyID SPOTIFY_TOKEN=myspotifytoken ./gomusic`
+
+Alternatively you can use `go run` too:
+`SPOTIFY_ID=myspotifyID SPOTIFY_TOKEN=myspotifytoken go run .`
+
+## Testing
+This application comes with a complete test suite, it can be run using the standard `go test` system
+When running tests you are required to provide the same credentials as when running the server normally.
+
+For example:
+`SPOTIFY_ID=myspotifyID SPOTIFY_TOKEN=myspotifytoken go test .`
+
+## Technical Choices
+This project is built using the Gin framework, for easy and consistent request contexts, as well as easy to expand middleware support.
+For database interactions it uses the gorm library, to allow for advanced SQL features and server agnostic support.
+
+This API currently uses sqlite as the database for simplicity, but switching to postgres or mysql is easy without any loss of functionality or change in database calls.
diff --git a/go.mod b/go.mod
index 25de27d..ec12a78 100644
--- a/go.mod
+++ b/go.mod
@@ -5,6 +5,8 @@ go 1.23.5
 require (
 	github.com/gin-gonic/gin v1.10.0
 	github.com/stretchr/testify v1.10.0
+	gorm.io/driver/sqlite v1.5.7
+	gorm.io/gorm v1.25.12
 )
 
 require (
@@ -38,6 +40,4 @@ require (
 	golang.org/x/text v0.22.0 // indirect
 	google.golang.org/protobuf v1.36.5 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	gorm.io/driver/sqlite v1.5.7 // indirect
-	gorm.io/gorm v1.25.12 // indirect
 )
diff --git a/main.go b/main.go
index e9ddd16..6745fd6 100644
--- a/main.go
+++ b/main.go
@@ -19,11 +19,8 @@ var spotifyClientSecret = os.Getenv("SPOTIFY_SECRET")
 
 func setupRouter(env *Env, spotifyID string, spotifySecret string) *gin.Engine {
     var r *gin.Engine = gin.Default()
-	
-	// Add our spotify auth middleware
 	r.Use(spotifyAuth(spotifyID, spotifySecret))
-
-    r.GET("/ping", env.ping)
+    r.GET("/alive", env.alive)
     r.GET("/artists/:artistID", env.getArtistByID)
     return r
 }
@@ -42,5 +39,5 @@ func main() {
     
 	// Router/middleware and server setup
     r := setupRouter(env, spotifyClientID, spotifyClientSecret)
-    r.Run(":8080")
+    r.Run(":8000")
 }
diff --git a/routes.go b/routes.go
index 1d2e085..6184a0e 100644
--- a/routes.go
+++ b/routes.go
@@ -7,8 +7,8 @@ import (
     "log/slog"
 )
 
-func (env *Env) ping(c *gin.Context) {
-    c.String(http.StatusOK, "pong")
+func (env *Env) alive(c *gin.Context) {
+    c.String(http.StatusOK, "yes!")
 }
 
 func (env *Env) getArtistByID(c *gin.Context) {
diff --git a/routes_test.go b/routes_test.go
index 41fd2cc..0908e29 100644
--- a/routes_test.go
+++ b/routes_test.go
@@ -9,17 +9,17 @@ import (
 	"fmt"
 )
 
-func TestPingRoute(t *testing.T) {
-	db := setupTestDatabase("testping")
+func TestAliveRoute(t *testing.T) {
+	db := setupTestDatabase("testalive")
 	env := &Env{db: db}
 	router := setupRouter(env, spotifyClientID, spotifyClientSecret)
 
 	w := httptest.NewRecorder()
-	req, _ := http.NewRequest("GET", "/ping", nil)
+	req, _ := http.NewRequest("GET", "/alive", nil)
 	router.ServeHTTP(w, req)
 
 	assert.Equal(t, 200, w.Code)
-	assert.Equal(t, "pong", w.Body.String())
+	assert.Equal(t, "yes!", w.Body.String())
 }
 
 func TestGetArtistByIDRoute(t *testing.T) {