Merge pull request #7 from ivan1993spb/dev

Update 4/19/2024

.github/workflows/go.yml

@@ -5,35 +5,38 @@ on: push
 jobs:
 
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
 
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.19.5
+        go-version: 1.21.5
 
     - name: Go Mod
       run: go mod download
 
-    # TODO: Add Go format step.
-    #- name: Go Format
-    #  run: gofmt -s -w . && git diff --exit-code
+    - name: Go Format
+      run: gofmt -s -w . && git diff --exit-code
 
     - name: Go Tidy
       run: go mod tidy && git diff --exit-code
 
+    # TODO: Add a propper vetting step go vet ./...
     - name: Go Vet
       run: go vet
 
-    # TODO: Add a staticcheck step.
-    #- uses: dominikh/[email protected]
-    #  with:
-    #    version: "2022.1"
-    #    install-go: false
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+        version: v1.55.2
 
-    # TODO: add go lint
+    - name: Go staticcheck
+      uses: dominikh/[email protected]
+      with:
+        version: "2023.1"
+        install-go: false
 
     - name: Go Build
       run: go build -v ./...

.github/workflows/openapi.yml

@@ -0,0 +1,14 @@
+on: push
+name: Validate OpenAPI specification
+jobs:
+  validate:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: swagger-validator
+      uses: mbowman100/swagger-validator-action@master
+      with:
+        files: api/openapi.yaml

.gitignore

@@ -1,6 +1,13 @@
+/snake-bot
+/*.html
+*.yaml
+*.json
+*.base64
+*.jwt
 *.diff
 *.patch
 *.log
 *.test
 *.out
 *.svg
+!examples/*

Dockerfile

@@ -1,13 +1,13 @@
 
 # See Makefile
-ARG IMAGE_GOLANG=golang:1.19.5-alpine3.16
-ARG IMAGE_ALPINE=alpine:3.16
+ARG IMAGE_GOLANG=golang:1.21.5-alpine3.19
+ARG IMAGE_ALPINE=alpine:3.19
 
 FROM $IMAGE_ALPINE AS helper
 
 RUN adduser -u 10001 -h /dev/null -H -D -s /sbin/nologin snake
 
-RUN sed -i '/^snake/!d' /etc/passwd
+RUN sed -i '/^snake/!d' /etc/passwd /etc/group
 
 FROM $IMAGE_GOLANG AS builder
 
@@ -21,12 +21,15 @@ COPY . .
 ENV CGO_ENABLED=0
 
 RUN go build \
-    -ldflags "-s -w -X main.Version=${VERSION} -X main.Build=${BUILD::7}" \
+    -ldflags "-s -w \
+        -X github.com/ivan1993spb/snake-bot/internal/app.Version=${VERSION} \
+        -X github.com/ivan1993spb/snake-bot/internal/app.Build=${BUILD::7}" \
     -v -x -o /snake-bot ./cmd/snake-bot
 
 FROM scratch
 
 COPY --from=helper /etc/passwd /etc/passwd
+COPY --from=helper /etc/group /etc/group
 
 USER snake
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Ivan Pushkin
+Copyright (c) 2024 Ivan Pushkin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -6,14 +6,18 @@ _=$(foreach exec,$(EXECUTABLES), \
 
 IMAGE=ivan1993spb/snake-bot
 
-IMAGE_GOLANG=golang:1.19.5-alpine3.16
-IMAGE_ALPINE=alpine:3.16
+IMAGE_GOLANG=golang:1.21.5-alpine3.19
+IMAGE_ALPINE=alpine:3.19
 
 BINARY_NAME=snake-bot
 VERSION=$(shell git describe --tags --abbrev=0 2>/dev/null || echo v0.0.0)
 BUILD=$(shell git rev-parse --short HEAD)
 
-LDFLAGS=-ldflags "-s -w -X main.Version=$(VERSION) -X main.Build=$(BUILD)"
+MODULE=github.com/ivan1993spb/snake-bot
+LDFLAGS=-ldflags "-s -w \
+	-X $(MODULE)/internal/app.Version=$(VERSION) \
+	-X $(MODULE)/internal/app.Build=$(BUILD)"
+
 DOCKER_BUILD_ARGS=\
  --build-arg VERSION=$(VERSION) \
  --build-arg BUILD=$(BUILD) \

README.md

@@ -1,15 +1,59 @@
 
-# The snake bot
+# Snake-Bot
 
-- **MVP**
-- clumsy
-- copypasta
-- no comments
-- no tests
-- bugs
+### Install Snake-Bot
 
 ```
-curl -X POST -H 'X-Snake-Bot-Token: hOayYn7Jbbq1TwDzJTsKX_eDb8Ww7LFEu0l6egnViGtCBCNbAPHo00b1uVCly9Rd' localhost:8080/config
+go install github.com/ivan1993spb/snake-bot@latest
 ```
 
-https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm
+### Start Snake-Server
+
+```
+docker run --rm -d -p 8080:8080 ivan1993spb/snake-server:latest --enable-web
+
+# Create a game
+curl -X POST -d limit=15 -d width=100 -d height=60 -d enable_walls=true localhost:8080/api/games
+```
+
+### Start Snake-Bot
+
+```
+# Generate a secret for JWT
+openssl rand -base64 -out secret.base64 32
+
+snake-bot -snake-server localhost:8080 -jwt-secret secret.base64 -address :9090
+```
+
+### Generate JWT
+
+```
+python3 scripts/getjwt.py --subject admin --jwt-secret secret.base64 > token.jwt
+token=`cat token.jwt`
+header="Authorization: Bearer ${token}"
+```
+
+### Call the API
+
+```
+# Get config
+curl -X GET -H "$header" localhost:9090/api/bots
+# Add 1 bot in game 1
+curl -X POST -H "$header" -d game=1 -d bots=1 localhost:9090/api/bots
+
+cd examples
+curl -X POST -H "$header" --data-binary @bots.yaml -H 'Content-Type: text/yaml' localhost:9090/api/bots
+curl -X POST -H "$header" --data-binary @bots.json -H 'Content-Type: application/json' localhost:9090/api/bots
+```
+
+### Watch the result
+
+[![Demo](demo.gif)](http://localhost:8080)
+
+### How it works
+
+[wiki: Dijkstra's algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm)
+
+### License
+
+See [LICENSE](LICENSE).

api/openapi.yaml

@@ -3,14 +3,14 @@ openapi: 3.0.3
 info:
   title: Snake-Bot API
   description: |
-    Snake-Bot provides control over a swarm of bots running on a
+    Snake-Bot service controls a swarm of bots running on a
     preconfigured instance of Snake-Server.
-  version: 0.0.0
+  version: 1.0.0
   license:
     name: MIT
   contact:
     name: Ivan Pushkin
-    url: https://twitter.com/IvanDeveloper
+    url: https://github.com/ivan1993spb
 
 servers:
   - url: /api
@@ -25,13 +25,13 @@ servers:
 paths:
   /bots:
     post:
-      summary: Launches a swarm of bots in specified games.
+      summary: Start bots.
       description: |
-        The method launches a given number of bots in a specified games.
+        The method starts the given numbers of bots in specified games.
       tags:
         - Bots
       security:
-        - ApiKeyAuth: []
+        - bearerAuth: []
       requestBody:
         required: true
         content:
@@ -46,32 +46,30 @@ paths:
               $ref: '#/components/schemas/Games'
       responses:
         201:
-          description: Current setup.
+          description: The bots have been started.
           content:
-            application/json:
+            text/yaml:
               schema:
                 $ref: '#/components/schemas/Games'
-            text/yaml:
+            application/json:
               schema:
                 $ref: '#/components/schemas/Games'
         400:
           $ref: '#/components/responses/InvalidParameters'
+        401:
+          $ref: '#/components/responses/AuthorizationError'
         500:
           $ref: '#/components/responses/ServerError'
         503:
-          description: Service unavailable, cannot create bots.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        404:
-          $ref: '#/components/responses/GameNotFound'
+          $ref: '#/components/responses/ServiceUnavailable'
     get:
-      summary: Returns the working current setup.
+      summary: Get the numbers of bots.
+      description: |
+        Returns the numbers of bots for each game.
       tags:
         - Bots
       security:
-        - ApiKeyAuth: []
+        - bearerAuth: []
       responses:
         200:
           description: Current setup.
@@ -82,52 +80,76 @@ paths:
             text/yaml:
               schema:
                 $ref: '#/components/schemas/Games'
+        400:
+          $ref: '#/components/responses/InvalidParameters'
+        401:
+          $ref: '#/components/responses/AuthorizationError'
+        500:
+          $ref: '#/components/responses/ServerError'
 
 components:
 
   securitySchemes:
-
-    ApiKeyAuth:
-      type: apiKey
-      in: header
-      name: X-Snake-Bot-Token
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
 
   responses:
     InvalidParameters:
       description: Invalid parameters.
       content:
+        text/yaml:
+          schema:
+            $ref: '#/components/schemas/Error'
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
     ServerError:
-      description: An internal server error.
+      description: Internal server error.
       content:
+        text/yaml:
+          schema:
+            $ref: '#/components/schemas/Error'
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-    GameNotFound:
-      description: A game has not been found.
+    AuthorizationError:
+      description: Authorization error.
       content:
+        text/yaml:
+          schema:
+            $ref: '#/components/schemas/Error'
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
+    ServiceUnavailable:
+      description: Service is unavailable.
+      content:
+        text/yaml:
+          schema:
+            $ref: '#/components/schemas/Error'
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
 
   schemas:
 
     Game:
       type: object
       description: |
-        The object contains a game identifier and a number of bots to launch.
+        The object contains a game ID and a number of bots.
       required:
         - game
         - bots
       properties:
         game:
-          description: A game identifier.
+          description: Game ID
           type: integer
           format: int32
         bots:
-          description: A bots number.
+          description: Number of bots
           type: integer
           format: int32
 
@@ -138,16 +160,15 @@ components:
         - games
       properties:
         games:
-          description: A list of game identifiers and numbers of bots.
+          description: A list of game IDs and numbers of bots.
           type: array
           items:
             $ref: '#/components/schemas/Game'
 
     Error:
       type: object
       description: |
-        The object contains an error code and short description of what went
-        wrong.
+        The object contains an error code and short description.
       required:
         - code
         - text