Merge branch 'imbs' of git.silversoft.se:Imbus/TTime into imbs

Better test feedback in python script
Silencing python testing, optional verbose output
2024-03-19 01:40:36 +01:00 · 2024-03-19 01:38:39 +01:00 · 2024-03-19 01:38:39 +01:00 · 2024-03-19 00:46:28 +01:00 · 2024-03-19 00:41:30 +01:00 · 2024-03-19 00:34:15 +01:00
4 changed files with 150 additions and 25 deletions
--- a/backend/docs/docs.go
+++ b/backend/docs/docs.go
@ -73,6 +73,11 @@ const docTemplate = `{
        },
        "/loginerenew": {
            "post": {
+                "security": [
+                    {
+                        "bererToken": []
+                    }
+                ],
                "description": "renews the users token",
                "consumes": [
                    "application/json"
@ -83,7 +88,7 @@ const docTemplate = `{
                "tags": [
                    "User"
                ],
-                "summary": "renews the users token",
+                "summary": "LoginRenews",
                "responses": {
                    "200": {
                        "description": "Successfully signed token for user",
@ -106,6 +111,58 @@ const docTemplate = `{
                }
            }
        },
+        "/promoteToAdmin": {
+            "post": {
+                "description": "promote chosen user to admin",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "text/plain"
+                ],
+                "tags": [
+                    "User"
+                ],
+                "summary": "PromoteToAdmin",
+                "parameters": [
+                    {
+                        "description": "user info",
+                        "name": "NewUser",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/types.NewUser"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Successfully prometed user",
+                        "schema": {
+                            "type": "json"
+                        }
+                    },
+                    "400": {
+                        "description": "bad request",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal server error",
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        },
        "/register": {
            "post": {
                "description": "Register a new user",
@ -118,7 +175,7 @@ const docTemplate = `{
                "tags": [
                    "User"
                ],
-                "summary": "Register a new user",
+                "summary": "Register",
                "parameters": [
                    {
                        "description": "User to register",
@ -164,7 +221,7 @@ const docTemplate = `{
                "tags": [
                    "User"
                ],
-                "summary": "Deletes a user",
+                "summary": "UserDelete",
                "responses": {
                    "200": {
                        "description": "User deleted",
@ -192,6 +249,41 @@ const docTemplate = `{
                    }
                }
            }
+        },
+        "/users/all": {
+            "get": {
+                "description": "lists all users",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "text/plain"
+                ],
+                "tags": [
+                    "User"
+                ],
+                "summary": "ListsAllUsers",
+                "responses": {
+                    "200": {
+                        "description": "Successfully signed token for user",
+                        "schema": {
+                            "type": "json"
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal server error",
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                }
+            }
        }
    },
    "definitions": {
@ -207,6 +299,13 @@ const docTemplate = `{
            }
        }
    },
+    "securityDefinitions": {
+        "bererToken": {
+            "type": "apiKey",
+            "name": "Authorization",
+            "in": "header"
+        }
+    },
    "externalDocs": {
        "description": "OpenAPI",
        "url": "https://swagger.io/resources/open-api/"
--- a/backend/internal/handlers/handlers_user_related.go
+++ b/backend/internal/handlers/handlers_user_related.go
@ -12,7 +12,7 @@ import (

 // Register is a simple handler that registers a new user
 //
-//	@Summary		Register a new user
+//	@Summary		Register
 //	@Description	Register a new user
 //	@Tags			User
 //	@Accept			json
@ -42,7 +42,7 @@ func (gs *GState) Register(c *fiber.Ctx) error {
 // This path should obviously be protected in the future
 // UserDelete deletes a user from the database
 //
-//	@Summary		Deletes a user
+//	@Summary		UserDelete
 //	@Description	UserDelete deletes a user from the database
 //	@Tags			User
 //	@Accept			json
@ -125,8 +125,9 @@ func (gs *GState) Login(c *fiber.Ctx) error {

 // LoginRenew is a simple handler that renews the token
 //
-//	@Summary		renews the users token
+//	@Summary		LoginRenews
 //	@Description	renews the users token
+//	@Security		bererToken
 //	@Tags			User
 //	@Accept			json
 //	@Produce		plain
@ -158,6 +159,16 @@ func (gs *GState) LoginRenew(c *fiber.Ctx) error {
 }

 // ListAllUsers is a handler that returns a list of all users in the application database
+//
+//	@Summary		ListsAllUsers
+//	@Description	lists all users
+//	@Tags			User
+//	@Accept			json
+//	@Produce		plain
+//	@Success		200	{json}		json	"Successfully signed token for user"
+//	@Failure		401	{string}	string	"Unauthorized"
+//	@Failure		500	{string}	string	"Internal server error"
+//	@Router			/users/all [get]
 func (gs *GState) ListAllUsers(c *fiber.Ctx) error {
 	// Get all users from the database
 	users, err := gs.Db.GetAllUsersApplication()
@ -171,6 +182,17 @@ func (gs *GState) ListAllUsers(c *fiber.Ctx) error {
 	return c.JSON(users)
 }

+//	@Summary		PromoteToAdmin
+//	@Description	promote chosen user to admin
+//	@Tags			User
+//	@Accept			json
+//	@Produce		plain
+//	@Param			NewUser	body		types.NewUser	true	"user info"
+//	@Success		200		{json}		json			"Successfully prometed user"
+//	@Failure		400		{string}	string			"bad request"
+//	@Failure		401		{string}	string			"Unauthorized"
+//	@Failure		500		{string}	string			"Internal server error"
+//	@Router			/promoteToAdmin [post]
 func (gs *GState) PromoteToAdmin(c *fiber.Ctx) error {
 	// Extract the username from the request body
 	var newUser types.NewUser
--- a/backend/main.go
+++ b/backend/main.go
@ -23,6 +23,10 @@ import (
 //	@license.name	AGPL
 //	@license.url	https://www.gnu.org/licenses/agpl-3.0.html

+//@securityDefinitions.apikey bererToken
+//@in header
+//@name Authorization
+
 //	@host		localhost:8080
 //	@BasePath	/api

@ -79,7 +83,7 @@ func main() {
 	}))

 	// Protected routes (require a valid JWT bearer token authentication header)
-	server.Post("/api/submitReport", gs.SubmitWeeklyReport)
+	server.Post("/api/submitWeeklyReport", gs.SubmitWeeklyReport)
 	server.Get("/api/getUserProjects", gs.GetUserProjects)
 	server.Post("/api/loginrenew", gs.LoginRenew)
 	server.Delete("/api/userdelete/:username", gs.UserDelete) // Perhaps just use POST to avoid headaches
@ -89,7 +93,7 @@ func main() {
 	server.Post("/api/signReport", gs.SignReport)
 	server.Put("/api/addUserToProject", gs.AddUserToProjectHandler)
 	server.Post("/api/promoteToAdmin", gs.PromoteToAdmin)
-
+	server.Get("/api/users/all", gs.ListAllUsers)
 	// Announce the port we are listening on and start the server
 	err = server.Listen(fmt.Sprintf(":%d", conf.Port))
 	if err != nil {
--- a/testing.py
+++ b/testing.py
@ -30,7 +30,7 @@ base_url = "http://localhost:8080"
 registerPath = base_url + "/api/register"
 loginPath = base_url + "/api/login"
 addProjectPath = base_url + "/api/project"
-submitReportPath = base_url + "/api/submitReport"
+submitReportPath = base_url + "/api/submitWeeklyReport"
 getWeeklyReportPath = base_url + "/api/getWeeklyReport"
 getProjectPath = base_url + "/api/project"
 signReportPath = base_url + "/api/signReport"
Author	SHA1	Message	Date
Imbus	5f88e92415	Merge branch 'imbs' of git.silversoft.se:Imbus/TTime into imbs	2024-03-19 01:40:36 +01:00
Imbus	09014c6659	Better test feedback in python script	2024-03-19 01:38:39 +01:00
Imbus	e498f0ed63	Silencing python testing, optional verbose output	2024-03-19 01:38:39 +01:00
Imbus	c03be8c5d9	Path rename in python testing script	2024-03-19 00:46:28 +01:00
Imbus	b174ec8922	Rename for clarity and consistensy with TS api	2024-03-19 00:41:30 +01:00
Imbus	2cfbcd15a7	Merge branch 'docs' of github.com:imbus64/TTime into docs	2024-03-19 00:34:15 +01:00
Samuel Högbom Aronson	9ce70e74e9	tyding up and tryinng to get tokens in docs to work	2024-03-19 00:33:38 +01:00
Samuel Högbom Aronson	3e35586bbe	finished docs for user reletaded stucts and added endpoint for listallusers	2024-03-19 00:33:38 +01:00
Samuel Högbom Aronson	8711f9a20d	tyding up and tryinng to get tokens in docs to work	2024-03-19 00:27:31 +01:00
Samuel Högbom Aronson	ad85194d4f	finished docs for user reletaded stucts and added endpoint for listallusers	2024-03-18 23:21:49 +01:00