add docs

Author: markhuang1212

README.md

@@ -5,16 +5,30 @@ This is a backend for grading C++ code in a secure and controlled manner.
 ## Usage
 
 ```shell
-> docker build . -t code-grader
-> docker run -p 8080 --privileged code-grader
+> docker-compose build
+> docker-compose up
 ```
 
 ## API
 
 ### Grade Code Request
 
+```bash
+curl --location --request POST 'http://localhost:8080/api/v1/grade' \
+    --header 'Content-Type: application/json' \
+    --data-raw '{
+        "TestCaseName": "example-1",
+        "UserCode": "int main() { cout << \"Hello\"; }"
+    }'
+```
+
 ### Retrieve Grade Result
 
+```bash
+curl --location \
+    --request GET 'http://localhost:8080/api/v1/result/cbaf98c458f3878df6f5'
+```
+
 ## Author
 
 Huang Meng \

backend/internal/api/setup_router.go

@@ -22,6 +22,10 @@ func SetupRouter(cc *core.CoreController) *gin.Engine {
 		c.String(http.StatusOK, "pong")
 	})
 
+	r.GET("/api", func(c *gin.Context) {
+		c.Redirect(http.StatusTemporaryRedirect, "https://app.swaggerhub.com/apis-docs/markhuang1212/CodeGraderCore")
+	})
+
 	authorized := r.Group("/api/v1")
 
 	authorized.POST("/grade", func(c *gin.Context) {

backend/internal/core/cache.go

@@ -2,18 +2,21 @@ package core
 
 import (
 	"sync"
+	"time"
 
 	"github.com/markhuang1212/code-grader/backend/internal/types"
 )
 
 type GradeResultCache struct {
-	Data map[string]types.GradeResult
-	Lock sync.RWMutex
+	Data    map[string]types.GradeResult
+	Lock    sync.RWMutex
+	Timeout time.Duration
 }
 
 func NewGradeResultCache() *GradeResultCache {
 	ret := GradeResultCache{
-		Data: make(map[string]types.GradeResult),
+		Data:    make(map[string]types.GradeResult),
+		Timeout: 12 * time.Minute,
 	}
 
 	return &ret
@@ -23,6 +26,10 @@ func (c *GradeResultCache) Add(key string, val types.GradeResult) {
 	c.Lock.Lock()
 	defer c.Lock.Unlock()
 	c.Data[key] = val
+	go func() {
+		time.Sleep(c.Timeout)
+		c.Del(key)
+	}()
 }
 
 func (c *GradeResultCache) Del(key string) {

backend/internal/core/cache_test.go

@@ -2,6 +2,7 @@ package core_test
 
 import (
 	"testing"
+	"time"
 
 	"github.com/markhuang1212/code-grader/backend/internal/core"
 	"github.com/markhuang1212/code-grader/backend/internal/types"
@@ -10,11 +11,15 @@ import (
 
 func TestCache(t *testing.T) {
 	c := core.NewGradeResultCache()
+	c.Timeout = 2 * time.Second
 	c.Add("id1", types.GradeResult{
 		Status: types.GradeResultCompilationError,
 		Msg:    "Hello",
 	})
 	ret, ok := c.Get("id1")
 	assert.True(t, ok)
 	assert.Equal(t, "Hello", ret.Msg)
+	time.Sleep(3 * time.Second)
+	ret, ok = c.Get("id1")
+	assert.False(t, ok)
 }

docker-compose.yml

@@ -10,16 +10,15 @@ services:
             - "8443:8443"
         volumes: 
             - /var/run/docker.sock:/var/run/docker.sock
+            - /tmp:/tmp
         deploy:
             resources:
                 limits:
                     memory: 4G
-                    cpus: '1.0'
+                    cpus: '2.0'
             restart_policy:
                 condition: on-failure
-                delay: 5s
                 max_attempts: 3
-                window: 120s
     runtime-compile:
         build: 
             context: .