Merge pull request #57 from servian/challenge

TWinsnes · web-flow · commit f58445e997bc · 2020-07-30T15:40:38.000+10:00
The Challenge is set.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -4,7 +4,7 @@
 version: 2
 jobs:
   build:
-    working_directory: /go/src/github.com/servian/TechTestApp
+    working_directory: /go/src/github.com/servian/TechChallengeApp
     docker:
       - image: circleci/golang:latest
 
@@ -17,7 +17,7 @@ jobs:
       - run: go test -v -race -cover ./...
 
   deploy:
-    working_directory: /go/src/github.com/servian/TechTestApp
+    working_directory: /go/src/github.com/servian/TechChallengeApp
     docker:
       - image: circleci/golang:latest
 
@@ -29,9 +29,9 @@ jobs:
           command: |
             go get -v -t -d ./...
             mkdir output
-            go build -v -o TechTestApp .
+            go build -v -o TechChallengeApp .
             ls
-            ./TechTestApp --version | sed -e 's/TechTestApp version /v./' > versionfile
+            ./TechChallengeApp --version | sed -e 's/TechChallengeApp version /v./' > versionfile
 
 
       - run: 
@@ -46,17 +46,17 @@ jobs:
             
             mkdir -p dist
             
-            go build -v -o TechTestApp .
+            go build -v -o TechChallengeApp .
             
-            cp TechTestApp dist/
+            cp TechChallengeApp dist/
             cp -r assets dist/
             cp conf.toml dist/
             
-            rm TechTestApp
+            rm TechChallengeApp
 
             export version=$(cat versionfile)
             
-            zip -r "output/TechTestApp_${version}_linux64.zip" dist/*
+            zip -r "output/TechChallengeApp_${version}_linux64.zip" dist/*
 
       # build for macos
       - run: 
@@ -71,17 +71,17 @@ jobs:
             
             mkdir -p dist
             
-            go build -v -o TechTestApp .
+            go build -v -o TechChallengeApp .
             
-            cp TechTestApp dist/
+            cp TechChallengeApp dist/
             cp -r assets dist/
             cp conf.toml dist/
             
-            rm TechTestApp
+            rm TechChallengeApp
 
             export version=$(cat versionfile)
 
-            zip -r "output/TechTestApp_${version}_darwin.zip" dist/*
+            zip -r "output/TechChallengeApp_${version}_darwin.zip" dist/*
 
       # build windows 64 bit
       - run: 
@@ -100,17 +100,17 @@ jobs:
             
             mkdir -p dist
             
-            go build -v -o TechTestApp.exe .
+            go build -v -o TechChallengeApp.exe .
             
-            cp TechTestApp.exe dist/
+            cp TechChallengeApp.exe dist/
             cp -r assets dist/
             cp conf.toml dist/
             
-            rm TechTestApp.exe
+            rm TechChallengeApp.exe
 
             export version=$(cat versionfile)
 
-            zip -r "output/TechTestApp_${version}_win64.zip" dist/*
+            zip -r "output/TechChallengeApp_${version}_win64.zip" dist/*
 
       #build windows 32 bit
       - run: 
@@ -125,17 +125,17 @@ jobs:
             
             mkdir -p dist
             
-            go build -v -o TechTestApp.exe .
+            go build -v -o TechChallengeApp.exe .
             
-            cp TechTestApp.exe dist/
+            cp TechChallengeApp.exe dist/
             cp -r assets dist/
             cp conf.toml dist/
             
-            rm TechTestApp.exe
+            rm TechChallengeApp.exe
 
             export version=$(cat versionfile)
 
-            zip -r "output/TechTestApp_${version}_win32.zip" dist/*
+            zip -r "output/TechChallengeApp_${version}_win32.zip" dist/*
 
       - run:
           name: Release if new version
@@ -171,4 +171,4 @@ workflows:
             branches:
               only: master
             tags:
-              ignore: /.*/
+              ignore: /.*/
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,7 +2,7 @@
 
 Please explain the changes you made here.
 
-Fixes: https://github.com/servian/TechTestApp/issues/{issue number}
+Fixes: https://github.com/servian/TechChallengeApp/issues/{issue number}
 
 ### Checklist
 
diff --git a/.gitignore b/.gitignore
@@ -21,4 +21,4 @@ dist/
 /vendor
 
 # Output Binary
-TechTestApp
+TechChallengeApp
diff --git a/ASSESSMENT.md b/ASSESSMENT.md
@@ -6,7 +6,7 @@ There *should not* be a requirement for Servian to access a candidate's cloud se
 
 Demonstrate regular commits and good git workflow practices.
 
-There is no time limit for this test.
+There is no time limit for this challenge.
 
 Candidates should provide documentation on their solution, including:
 
@@ -51,7 +51,7 @@ Candidates will be assessed across the following categories:
 - Auto scaling and highly available frontend
 - Highly available Database
 
-## Tech Test Application
+## Tech Challenge Application
 
 Single page application designed to be ran inside a container or on a vm (IaaS) with a postgres database to store data.
 
@@ -67,9 +67,9 @@ It is completely self contained, and should not require any additional dependenc
 
 update `conf.toml` with database settings
 
-`./TechTestApp updatedb` to create a database and seed it with test data
+`./TechChallengeApp updatedb` to create a database and seed it with test data
 
-`./TechTestApp serve` will start serving requests
+`./TechChallengeApp serve` will start serving requests
 
 ## Interesting endpoints
 
@@ -89,12 +89,12 @@ update `conf.toml` with database settings
 
 ### Process
 
-`go get -d github.com/Servian/TechTestApp`
+`go get -d github.com/Servian/TechChallengeApp`
 
 run `build.sh`
 
 the `dist` folder contains the compiled web package
 
 ### Docker build
 
-`docker build . -t techtestapp:latest`
+`docker build . -t techchallengeapp:latest`
diff --git a/Dockerfile b/Dockerfile
@@ -12,26 +12,26 @@ RUN go get -d -v github.com/go-swagger/go-swagger \
     && mv /tmp/swagger-ui-$SWAGGER_UI_VERSION /tmp/swagger \
     && sed -i 's#"https://petstore\.swagger\.io/v2/swagger\.json"#"./swagger.json"#g' /tmp/swagger/dist/index.html
 
-WORKDIR $GOPATH/src/github.com/servian/TechTestApp
+WORKDIR $GOPATH/src/github.com/servian/TechChallengeApp
 
-COPY go.mod go.sum $GOPATH/src/github.com/servian/TechTestApp/
+COPY go.mod go.sum $GOPATH/src/github.com/servian/TechChallengeApp/
 
 RUN go mod tidy
 
 COPY . .
 
-RUN go build -o /TechTestApp
+RUN go build -o /TechChallengeApp
 RUN swagger generate spec -o /swagger.json
 
 FROM alpine:latest
 
-WORKDIR /TechTestApp
+WORKDIR /TechChallengeApp
 
 COPY assets ./assets
 COPY conf.toml ./conf.toml
 
 COPY --from=build /tmp/swagger/dist ./assets/swagger
 COPY --from=build /swagger.json ./assets/swagger/swagger.json
-COPY --from=build /TechTestApp TechTestApp
+COPY --from=build /TechChallengeApp TechChallengeApp
 
-ENTRYPOINT [ "./TechTestApp" ]
+ENTRYPOINT [ "./TechChallengeApp" ]
diff --git a/build.sh b/build.sh
@@ -8,10 +8,10 @@ mkdir -p dist
 
 go mod tidy
 
-go build -o TechTestApp .
+go build -o TechChallengeApp .
 
-cp TechTestApp dist/
+cp TechChallengeApp dist/
 cp -r assets dist/
 cp conf.toml dist/
 
-rm TechTestApp
+rm TechChallengeApp
diff --git a/cmd/root.go b/cmd/root.go
@@ -24,8 +24,8 @@ import (
   "fmt"
   "os"
 
-  "github.com/servian/TechTestApp/config"
-  "github.com/servian/TechTestApp/daemon"
+  "github.com/servian/TechChallengeApp/config"
+  "github.com/servian/TechChallengeApp/daemon"
   "github.com/spf13/cobra"
 )
 
@@ -34,7 +34,7 @@ var cfg *daemon.Config
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-  Use:   "TechTestApp",
+  Use:   "TechChallengeApp",
   Short: "Application used to test potential candidates at Servian",
   Long: `
  .:ooooool,      .:odddddl;.      .;ooooc. .l,          ;c.    ::.      'coddddoc'         ,looooooc.                  
diff --git a/cmd/serve.go b/cmd/serve.go
@@ -24,7 +24,7 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/servian/TechTestApp/daemon"
+	"github.com/servian/TechChallengeApp/daemon"
 	"github.com/spf13/cobra"
 )
 
diff --git a/cmd/updatedb.go b/cmd/updatedb.go
@@ -23,7 +23,7 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/servian/TechTestApp/db"
+	"github.com/servian/TechChallengeApp/db"
 	"github.com/spf13/cobra"
 )
 
diff --git a/daemon/deamon.go b/daemon/deamon.go
@@ -27,7 +27,7 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/servian/TechTestApp/ui"
+	"github.com/servian/TechChallengeApp/ui"
 )
 
 // Config - configuration for daemon package
diff --git a/db/db.go b/db/db.go
@@ -28,7 +28,7 @@ import (
 	"github.com/lib/pq"
 
 	_ "github.com/lib/pq"
-	"github.com/servian/TechTestApp/model"
+	"github.com/servian/TechChallengeApp/model"
 )
 
 // Config - configuration for the db package
diff --git a/doc/adr/0006-environment-variables-overrides-config-file.md b/doc/adr/0006-environment-variables-overrides-config-file.md
@@ -10,7 +10,7 @@ Supercedes [4. config only in config file](0004-config-only-in-config-file.md)
 
 ## Context
 
-In some environments the port and other variables are only available on startup, and will have to be overriden. See https://github.com/servian/TechTestApp/issues/21
+In some environments the port and other variables are only available on startup, and will have to be overriden. See https://github.com/servian/TechChallengeApp/issues/21
 
 ## Decision
 
diff --git a/doc/config.md b/doc/config.md
@@ -1,4 +1,4 @@
-# TechTestApp - Configuration
+# TechChallengeApp - Configuration
 
 This doc outlines how to configure the application using the config file. The main way to configure the application is through the configuration file, but it is possible to override the settings using environment variables.
 
@@ -32,4 +32,4 @@ The application will look for environment variables that are able to override th
 
 Environment variables has precedence over configuration from the `conf.toml` file
 
-More details on each of the configuration values can be found in the section on the configuration file.
+More details on each of the configuration values can be found in the section on the configuration file.
diff --git a/doc/readme.md b/doc/readme.md
@@ -1,20 +1,20 @@
-# TechTestApp
+# TechChallengeApp
 
 [![Build Status][circleci-badge]][circleci]
 [![Release][release-badge]][release]
 [![GoReportCard][report-badge]][report]
 [![License][license-badge]][license]
 
-[circleci-badge]: https://circleci.com/gh/servian/TechTestApp.svg?style=shield&circle-token=8dfd03c6c2a5dc5555e2f1a84c36e33bc58ad0aa
-[circleci]: https://circleci.com/gh/servian/TechTestApp
-[release-badge]: http://img.shields.io/github/release/servian/TechTestApp/all.svg?style=flat
-[release]:https://github.com/servian/TechTestApp/releases
-[report-badge]: https://goreportcard.com/badge/github.com/servian/TechTestApp
-[report]: https://goreportcard.com/report/github.com/servian/TechTestApp
-[license-badge]: https://img.shields.io/github/license/servian/TechTestApp.svg?style=flat
-[license]: https://github.com/servian/TechTestApp/license
+[circleci-badge]: https://circleci.com/gh/servian/TechChallengeApp.svg?style=shield&circle-token=8dfd03c6c2a5dc5555e2f1a84c36e33bc58ad0aa
+[circleci]: https://circleci.com/gh/servian/TechChallengeApp
+[release-badge]: http://img.shields.io/github/release/servian/TechChallengeApp/all.svg?style=flat
+[release]:https://github.com/servian/TechChallengeApp/releases
+[report-badge]: https://goreportcard.com/badge/github.com/servian/TechChallengeApp
+[report]: https://goreportcard.com/report/github.com/servian/TechChallengeApp
+[license-badge]: https://img.shields.io/github/license/servian/TechChallengeApp.svg?style=flat
+[license]: https://github.com/servian/TechChallengeApp/license
 
-The Servian techtest app is a golang application used for testing candidates applying to work with Servian.
+The Servian tech challenge app is a golang application used for challenging candidates applying to work with Servian.
 
 ## Documentation structure
 
@@ -27,7 +27,7 @@ Architectural decisions are recorded in the `adr` folder, details on why can be
 
 Naming convention: `####-<decision title>` where the first 4 digits are iterated by 1 for each record.
 
-## Tech Test Application
+## Tech Challenge Application
 
 Single page application designed to be ran inside a container or on a vm (IaaS) with a postgres database to store data.
 
@@ -54,9 +54,9 @@ Tested against:
 
 update `conf.toml` with database settings (details on how to configure the application can be found in [config.md](config.md))
 
-`TechTestApp updatedb` to create a database, tables, and seed it with test data. Use `-s` to skip creating the database and only create tabls and seed data.
+`TechChallengeApp updatedb` to create a database, tables, and seed it with test data. Use `-s` to skip creating the database and only create tabls and seed data.
 
-`TechTestApp serve` will start serving requests
+`TechChallengeApp serve` will start serving requests
 
 ## Interesting endpoints
 
@@ -111,7 +111,7 @@ If building using docker you need to have docker installed on your local machine
 
 Download the application using go get:
 
-`go get -d github.com/servian/TechTestApp`
+`go get -d github.com/servian/TechChallengeApp`
 
 run `build.sh` to download all the dependencies and compile the application
 
@@ -121,15 +121,15 @@ the `dist` folder contains the compiled web package
 
 To build a docker image with the application installed on it
 
-`docker build . -t techtestapp:latest`
+`docker build . -t techchallengeapp:latest`
 
 
 ### Pull Image from Github packages
 
-Go to the [packages](https://github.com/servian/TechTestApp/packages) section for an already built docker image. 
+Go to the [packages](https://github.com/servian/TechChallengeApp/packages) section for an already built docker image. 
 To pull a ready built docker image with the application installed on it, [setup](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages) docker to auth to Github then:
 
-`docker pull docker.pkg.github.com/servian/techtestapp/techtestapp:latest`
+`docker pull docker.pkg.github.com/servian/techchallengeapp/techchallengeapp:latest`
 
 
 ## Continuous Integration
@@ -155,4 +155,4 @@ Builds will be produced for:
 * Windows (x86/amd64)
 
 #### Note
-* If you are setting up the database using RDS, do not run the `./TechTestApp updatedb` command. Instead run `./TechTestApp updatedb -s` 
+* If you are setting up the database using RDS, do not run the `./TechChallengeApp updatedb` command. Instead run `./TechChallengeApp updatedb -s` 
diff --git a/go.mod b/go.mod
diff --git a/main.go b/main.go
diff --git a/readme.md b/readme.md
diff --git a/ui/api.go b/ui/api.go
diff --git a/ui/index.go b/ui/index.go
diff --git a/ui/ui.go b/ui/ui.go

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ import (`
`24`	`24`	`"log"`
`25`	`25`	`"net/http"`
`26`	`26`
`27`		`- "github.com/servian/TechTestApp/daemon"`
	`27`	`+ "github.com/servian/TechChallengeApp/daemon"`
`28`	`28`	`"github.com/spf13/cobra"`
`29`	`29`	`)`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ package cmd`
`23`	`23`	`import (`
`24`	`24`	`"fmt"`
`25`	`25`
`26`		`- "github.com/servian/TechTestApp/db"`
	`26`	`+ "github.com/servian/TechChallengeApp/db"`
`27`	`27`	`"github.com/spf13/cobra"`
`28`	`28`	`)`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ import (`
`27`	`27`	`"os/signal"`
`28`	`28`	`"syscall"`
`29`	`29`
`30`		`- "github.com/servian/TechTestApp/ui"`
	`30`	`+ "github.com/servian/TechChallengeApp/ui"`
`31`	`31`	`)`
`32`	`32`
`33`	`33`	`// Config - configuration for daemon package`