Added tests, updated readme

Author: classPythonAddike

README.md

@@ -48,77 +48,83 @@ MAX_FILE_SIZE=30
 
 ### Running
 
-- To create postgres container `make postgres`
-- To create db `make createdb`
-- To drop db `make dropdb`
+- To create the Postgres container - `make postgres`
+- To create the db - `make createdb`
+- To drop db - `make dropdb`
 
-#### run `go mod tidy` to install packages
-#### cli commands 
+#### Run `go mod tidy` to install packages
+#### CLI commands 
 ```
 go run main.go migrate_up
 go run main.go dropdb
 go run main.go migrate_steps --steps int
+go run main.go generate_docs
 go run main.go runserver --host localhost --port port (localhost, 5000 are default)
 ```
 
-#### to run migrations on the test database 
+#### To run migrations on the test database
 ```
 go run main.go migrate_up -t
 go run main.go dropdb -t
 go run main.go migrate_steps -t --steps int
 ```
 
-### Use the make file its your best friend 🛠
-#### Make commands
-##### If you are on windows please use git bash or wsl also you would have to install make for windows
-##### to install make for windows run `winget install GnuWin32.Make`
+### Use the make file, its your best friend 🛠
+#### Make commands -
+If you are on windows please use Git Bash or WSL. You also have to install Make for Windows
+To install Make for Windows run `winget install GnuWin32.Make`
 
 ```shell
-make postgres #creates docker container for postgres12
-# reads env variables from app.env
-make createdb #creates the db in the postgres container
-make dropdb #drops the db
-make migrate_up #migrates to the latest schema
-make sqlc_generate #generates sqlc code if you write queries
-make test # tests your code and shows coverage
-#its a big output make sure to read it all
+make postgres # Creates docker container for postgres12
+# Reads env variables from app.env
+make createdb # Creates the db in the postgres container
+make dropdb # Drops the db
+make migrate_up # Migrates to the latest schema
+make sqlc_generate # Generates sqlc code if you write queries
+make generate_docs # Generates documentation
+make test # Tests your code and shows coverage
+# Its a big output make sure to read it all
 ```
 
 ## 🐳 Running with Docker
 
-Start the cdn `docker-compose up`
+Start the cdn with `docker-compose up`
 
 ## 🗒️Docs
 
 While adding new endpoints, you need add docs in the form of comments. For example:
 ```go
-
 /*
-Return Type: String
+Response: String
 
 URL Parameters: None
 
-Returns `Hello, World` when called.
+Request Body:
+	- Name: username
+	- Type: String
+	- Description: "Username to register so and so . . ."
+
+Description: "Returns `Hello, World` when called."
 */
 func GetAllAssets(w http.ResponseWriter, r *http.Request) {
     w.WriteHeader(statusCode)
     json.NewEncoder(w).Encode("Hello, World")
 }
 ```
 
-And you will need to update the routes variable in [main.go](/main.go)
+And you will need to update the routes variable in [routes.go](/api/routes.go)
 
 ## 🚨 Tests
-To test the cdn we can use two methods
+There are two methods to test the cdn -
 ```sh
 make test
 ```
-If you don't have make installed
+If you don't have make installed -
 ```sh
 go run main.go migrate_up -t
 go test ./... -v 
 ```
-**When you contribute, you need to add tests on the features you add.**
+**When you contribute, you need to add tests for the features you add.**
 
 ## ⛏️ Built Using
 
@@ -127,4 +133,4 @@ go test ./... -v
 - [sqlc](https://github.com/kyleconroy/sqlc) - Database Query Helper
 
 ## ✍️ Authors
-See the list of [contributors](https://github.com/Tech-With-Tim/cdn/contributors) who participated in this project.
+See the list of [contributors](https://github.com/Tech-With-Tim/cdn/contributors) who participated in this project.

api/handlers/create_asset.go

@@ -75,12 +75,12 @@ Response: JSON
 URL Parameters: None
 
 Request Body:
-  - name: name
-    type: String
-    Desc: "Name under which to store the asset in the CDN."
-  - name: url_path
-    type: String
-    Desc: "The URL Path under which to store the asset in the CDN.
+  - Name: name
+    Type: String
+    Description: "Name under which to store the asset in the CDN."
+  - Name: url_path
+    Type: String
+    Description: "The URL Path under which to store the asset in the CDN.
     If none is provided, a random path is selected."
 
 Description: "Create Asset creates an asset with a given file,

api/handlers_test.go

@@ -10,11 +10,13 @@ import (
 	"mime/multipart"
 	"net/http"
 	"net/http/httptest"
+	"os"
 	"strconv"
 	"testing"
 	"time"
 
 	db "github.com/Tech-With-Tim/cdn/db/sqlc"
+	"github.com/Tech-With-Tim/cdn/docs"
 
 	"github.com/Tech-With-Tim/cdn/utils"
 	"github.com/golang-jwt/jwt"
@@ -92,6 +94,15 @@ func TestHelloWorld(t *testing.T) {
 	checkResponseCode(t, http.StatusUnauthorized, response.Code)
 }
 
+func TestDocs(t *testing.T) {
+
+	GenerateDocs(t)
+
+	req, _ := http.NewRequest("GET", "/docs/docs.json", nil)
+	response := executeRequest(req)
+	checkResponseCode(t, http.StatusUnauthorized, response.Code)
+}
+
 func TestCreateAsset(t *testing.T) {
 	authToken, err := createAuthToken(time.Now().Add(time.Hour * 24).Unix())
 	require.NoError(t, err)
@@ -201,3 +212,27 @@ func TestCreateAsset(t *testing.T) {
 		checkResponseCode(t, http.StatusBadRequest, fileRes.Code)
 	}
 }
+
+func GenerateDocs(t *testing.T) {
+	err := os.Chdir("./api/handlers")
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	for route, handler := range Routes {
+		err := docs.AddDocs(route, handler)
+
+		if err != nil {
+			t.Fatal(err)
+		}
+	}
+
+	docs.GenerateDocs()
+
+	_, err = os.Stat("../../docs/docs-template/public/docs.json")
+
+	if os.IsNotExist(err) {
+		t.Fatal(err)
+	}
+}

docs/register.go

@@ -24,9 +24,9 @@ type RouteInfo struct {
 	Route string
 
 	RequestBody []struct {
-		Name string `yaml:"name"`
-		Type string `yaml:"type"`
-		Desc string `yaml:"Desc"`
+		Name string `yaml:"Name"`
+		Type string `yaml:"Type"`
+		Desc string `yaml:"Description"`
 	} `yaml:"Request Body"`
 
 	Description string `yaml:"Description"`