Pulling refactor/arangodb-backend into develop

.github/workflows/ci.yml

@@ -7,31 +7,26 @@ jobs:
   test:
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres:9.6.6-alpine
+      arangodb:
+        image: arangodb:3.10.9
         env:
-          POSTGRES_DB: pgtest
-          POSTGRES_USER: pguser
-          POSTGRES_PASSWORD: pgdocker
+          ARANGO_ROOT_PASSWORD: rootpass
         ports:
-          - 5432/tcp
+          - 8529/tcp
     steps:
       - name: set up golang
         uses: actions/setup-go@v4
         with:
           go-version: '~1.20.6'
       - name: check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
       - name: unit test
-        run: go test -covermode=atomic -coverprofile=profile.cov -v ./...
+        run: go test -parallel 4 -covermode=atomic -coverprofile=profile.cov -v ./...
         env:
-          POSTGRES_DB: pgtest
-          POSTGRES_USER: pguser
-          POSTGRES_PASSWORD: pgdocker
-          POSTGRES_HOST: localhost
-          POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
-          NATS_HOST: localhost
-          NATS_PORT: ${{ job.services.nats.ports[4222] }}
+          ARANGO_USER: root
+          ARANGO_PASS: rootpass
+          ARANGO_HOST: localhost
+          ARANGO_PORT: ${{ job.services.arangodb.ports[8529] }}
           GOPROXY: https://proxy.golang.org
       - name: upload coverage to codecov
         uses: codecov/codecov-action@v3

.github/workflows/testcov.yml

@@ -4,31 +4,26 @@ jobs:
   test:
     runs-on: ubuntu-latest
     services:
-      postgres:
-        image: postgres:9.6.6-alpine
+      arangodb:
+        image: arangodb:3.10.9
         env:
-          POSTGRES_DB: pgtest
-          POSTGRES_USER: pguser
-          POSTGRES_PASSWORD: pgdocker
+          ARANGO_ROOT_PASSWORD: rootpass
         ports:
-          - 5432/tcp
+          - 8529/tcp
     steps:
       - name: set up golang
         uses: actions/setup-go@v4
         with:
           go-version: '~1.20.6'
       - name: check out code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
       - name: unit test
-        run: go test -covermode=atomic -coverprofile=profile.cov -v ./...
+        run: go test -parallel 4 -covermode=atomic -coverprofile=profile.cov -v ./...
         env:
-          POSTGRES_DB: pgtest
-          POSTGRES_USER: pguser
-          POSTGRES_PASSWORD: pgdocker
-          POSTGRES_HOST: localhost
-          POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
-          NATS_HOST: localhost
-          NATS_PORT: ${{ job.services.nats.ports[4222] }}
+          ARANGO_USER: root
+          ARANGO_PASS: rootpass
+          ARANGO_HOST: localhost
+          ARANGO_PORT: ${{ job.services.arangodb.ports[8529] }}
           GOPROXY: https://proxy.golang.org
       - name: upload coverage to codecov
         uses: codecov/codecov-action@v3

.gitignore

@@ -1,2 +1 @@
 vendor/
-modware-content

.golangci.yml

@@ -4,16 +4,14 @@ run:
 linters-settings:
    funlen: 
     lines: 80
-    statements: 50
-   lll:
-      line-length: 130
    revive:
       rules:
         - name: var-naming
           arguments: [["ID"]]
    gosec:
       excludes:
         - G404
+        - G402
    wrapcheck:
       ignoreSigs:
         - .HandleMessagingError(
@@ -36,57 +34,31 @@ linters:
     - bodyclose
     - bidichk
     - cyclop 
-    - decorder
     - depguard
+    - decorder
     - dogsled
-    - dupl
+    # - dupl
     - errcheck
-    - errname
     - funlen
-    - gci
-    - gochecknoinits
     - goconst
     - gocritic
     - gocyclo
-    - godot
     - gofmt
     - goimports
     - gosec
     - gosimple
     - govet
-    - gocognit
-    - gomnd 
-    - gomoddirectives
-    - gomodguard
-    - grouper
     - ineffassign
-    - importas
     - lll
-    - maintidx
     - misspell
     - nakedret
-    - nestif
-    - nilerr
-    - nlreturn
-    - nolintlint
-    - prealloc
-    # - paralleltest
-    - predeclared
     - revive
-    - rowserrcheck
     - staticcheck
     - typecheck
     - unconvert
-    - thelper
-    - tparallel
     - unparam
     - unused
-    - unconvert
-    - unparam
-    - varnamelen
-    - wastedassign
     - whitespace
-    - wrapcheck
 
   # don't enable:
   # - godox

README.md

@@ -1,8 +1,4 @@
 # modware-user
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-
 [![License](https://img.shields.io/badge/License-BSD%202--Clause-blue.svg)](LICENSE)  
 ![Continuous integration](https://github.com/dictyBase/modware-content/workflows/Continuous%20integration/badge.svg)
 [![codecov](https://codecov.io/gh/dictyBase/modware-content/branch/develop/graph/badge.svg)](https://codecov.io/gh/dictyBase/modware-content)
@@ -68,22 +64,3 @@ The protocol buffer definitions and service apis are documented
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/dictyBase/modware-content?style=plastic)
 [![Lines of Code](https://badgen.net/codeclimate/loc/dictyBase/modware-content)](https://codeclimate.com/github/dictyBase/modware-content/code)  
 
-## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="http://cybersiddhu.github.com/"><img src="https://avatars3.githubusercontent.com/u/48740?v=4" width="100px;" alt=""/><br /><sub><b>Siddhartha Basu</b></sub></a><br /><a href="https://github.com/dictyBase/modware-content/issues?q=author%3Acybersiddhu" title="Bug reports">🐛</a> <a href="https://github.com/dictyBase/modware-content/commits?author=cybersiddhu" title="Code">💻</a> <a href="#content-cybersiddhu" title="Content">🖋</a> <a href="https://github.com/dictyBase/modware-content/commits?author=cybersiddhu" title="Documentation">📖</a> <a href="#maintenance-cybersiddhu" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="http://www.erichartline.net/"><img src="https://avatars3.githubusercontent.com/u/13489381?v=4" width="100px;" alt=""/><br /><sub><b>Eric Hartline</b></sub></a><br /><a href="https://github.com/dictyBase/modware-content/issues?q=author%3Awildlifehexagon" title="Bug reports">🐛</a> <a href="https://github.com/dictyBase/modware-content/commits?author=wildlifehexagon" title="Code">💻</a> <a href="#content-wildlifehexagon" title="Content">🖋</a> <a href="https://github.com/dictyBase/modware-content/commits?author=wildlifehexagon" title="Documentation">📖</a> <a href="#maintenance-wildlifehexagon" title="Maintenance">🚧</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-enable -->
-<!-- prettier-ignore-end -->
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

build/package/Dockerfile

@@ -12,10 +12,8 @@ COPY go.mod ./
 COPY go.sum ./
 COPY main.go ./
 RUN go mod download
-ADD server server
-ADD commands commands
-ADD message message
-ADD validate validate
+ADD cmd cmd
+ADD internal internal
 RUN go build \
     -a \
     -ldflags "-s -w -extldflags '-static'" \

cmd/modware-content/main.go

@@ -0,0 +1,65 @@
+package main
+
+import (
+	"log"
+	"os"
+
+	apiflag "github.com/dictyBase/aphgrpc"
+	arangoflag "github.com/dictyBase/arangomanager/command/flag"
+	"github.com/dictyBase/modware-content/internal/app/server"
+	"github.com/urfave/cli"
+)
+
+func main() {
+	app := cli.NewApp()
+	app.Name = "modware-content"
+	app.Usage = "cli for modware-content microservice"
+	app.Version = "2.0.0"
+	app.Flags = []cli.Flag{
+		cli.StringFlag{
+			Name:  "log-format",
+			Usage: "format of the logging out, either of json or text.",
+			Value: "json",
+		},
+		cli.StringFlag{
+			Name:  "log-level",
+			Usage: "log level for the application",
+			Value: "error",
+		},
+	}
+	app.Commands = []cli.Command{
+		{
+			Name:   "start-server",
+			Usage:  "starts the modware-content microservice with HTTP and grpc backends",
+			Action: server.RunServer,
+			Flags:  getServerFlags(),
+		},
+	}
+	if err := app.Run(os.Args); err != nil {
+		log.Fatalf("error in running command %s", err)
+	}
+}
+
+func getServerFlags() []cli.Flag {
+	flg := []cli.Flag{
+		cli.StringFlag{
+			Name:  "port",
+			Usage: "tcp port at which the server will be available",
+			Value: "9560",
+		},
+		cli.StringFlag{
+			Name:  "content-collection",
+			Usage: "arangodb collection for storing editor data",
+			Value: "serialized_json",
+		},
+		cli.StringFlag{
+			Name:   "arangodb-database, db",
+			EnvVar: "ARANGODB_DATABASE",
+			Usage:  "arangodb database name",
+			Value:  "content",
+		},
+	}
+	flg = append(flg, arangoflag.ArangoFlags()...)
+
+	return append(flg, apiflag.NatsFlag()...)
+}