feat: new valkeyrie core (#74)

Author: ldez

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,58 @@
+name: Bug Report
+description: "Create a report to help us improve."
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome
+      options:
+        - label: Yes, I've searched similar issues on GitHub and didn't find any.
+          required: true
+        - label: Yes, I've included all information below (version, config, etc).
+          required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Description of the problem
+      placeholder: Your problem description
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Version of Valkeyrie
+    validations:
+      required: true
+
+  - type: textarea
+    id: go-env
+    attributes:
+      label: Go environment
+      value: |-
+        <details>
+
+        ```console
+        $ go version && go env
+        # paste output here
+        ```
+
+        </details>
+    validations:
+      required: true
+
+  - type: textarea
+    id: code-example
+    attributes:
+      label: Code example or link to a public repository
+      value: |-
+        <details>
+
+        ```go
+        // add your code here
+        ```
+
+        </details>
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions
+    url: https://github.com/kvtools/valkeyrie/discussions
+    about: If you have a question, or are looking for advice, please post on our Discussions forum!
+

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,35 @@
+name: Feature request
+description: "Suggest an idea for this project."
+body:
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Your feature request related to a problem? Please describe.
+      placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like.
+      placeholder: "A clear and concise description of what you want to happen."
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered.
+      placeholder: "A clear and concise description of any alternative solutions or features you've considered."
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context.
+      placeholder: "Add any other context or screenshots about the feature request here."
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/new_store.yml

@@ -0,0 +1,25 @@
+name: Add a new type of store
+description: "Proposal"
+body:
+
+  - type: input
+    id: store-name
+    attributes:
+      label: The name of the store.
+    validations:
+      required: true
+
+  - type: input
+    id: repo-url
+    attributes:
+      label: The URL of your repository.
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Provide information about the store.
+      placeholder: "A clear and concise description."
+    validations:
+      required: false

.golangci.yml

@@ -8,19 +8,16 @@ linters-settings:
     enable-all: true
     disable:
       - fieldalignment
-      - shadow # FIXME the issues reported must be reviewed.
   gocyclo:
     min-complexity: 15
-  maligned:
-    suggest-new: true
   goconst:
     min-len: 5
     min-occurrences: 3
   misspell:
     locale: US
   funlen:
     lines: -1
-    statements: 40
+    statements: 45
   godox:
     keywords:
       - FIXME
@@ -47,14 +44,13 @@ linters-settings:
       hugeParam:
         sizeThreshold: 100
   stylecheck:
-    go: "1.16"
     checks:
       - "all"
-      - "-ST1005" # FIXME MUST be fixed (error strings should not be capitalized)
 
 linters:
   disable-all: true
   enable:
+    - asasalint
     - asciicheck
     - bidichk
     - bodyclose
@@ -64,7 +60,7 @@ linters:
     - durationcheck
     - errcheck
     - errname
-#    - errorlint # TODO can be used in future.
+    - errorlint
     - exportloopref
     - forbidigo
     - forcetypeassert
@@ -91,7 +87,7 @@ linters:
     - govet
     - importas
     - ineffassign
-#    - makezero # TODO can be used in future. Required to check the current reported issues.
+    - makezero
     - misspell
     - nakedret
     - nestif
@@ -110,6 +106,7 @@ linters:
     - unconvert
     - unparam
     - unused
+    - usestdlibvars
     - wastedassign
     - whitespace
 
@@ -123,13 +120,7 @@ issues:
       linters:
         - goconst
         - funlen
-    - path: "testutils/utils.go"
-      linters: [ "funlen" ]
     - path: "valkeyrie.go"
       linters:
         - gochecknoglobals
-    - path: "store/mock/mock.go"
-      linters:
-        - forcetypeassert
-    - path: store/redis/redis.go
-      text: 'Function `NewClient->newConnPool->NewConnPool->reaper->checkMinIdleConns` should pass the context parameter'
+

CONTRIBUTING.md

@@ -15,7 +15,7 @@ this document carefully.
 
 - Git
 - Golang
-- One or all of the supported datastores (Zookeeper / Consul / Etcd / Redis / BoltDB)
+- One or all of the supported datastore (Zookeeper / Consul / Etcd / Redis / BoltDB)
 
 ### Installing Golang
 
@@ -25,144 +25,17 @@ following these [Guidelines](https://golang.org/doc/install).
 An easy way to get started on mac OS is to use [homebrew](https://brew.sh) and type
 `brew install go` in a shell.
 
-In addition to the language runtime, make sure you install these tools locally using
-`go get`:
-
-- **fmt** (to format source code)
-- **goimports** (to automatically include and triage imports)
-
-Once you have a working Go installation, follow the next steps:
-
-- Get the repository:
-
-        go get -u github.com/kvtools/valkeyrie
-
-- Checkout on a new branch from the master branch to start working on a patch
-
-        git checkout -b mybranch
-
 ### Local testing of key/value stores
 
-In addition to installing golang, you will need to install some or all of the key
-value stores for testing.
+In addition to installing golang, you will need to install some or all of the key value stores for testing.
 
 Refer to each of these stores documentation in order to proceed with installation.
-Generally, the tests are using the **default configuration** with the **default port**
-to connect to a store and run the test suite.
-
-To test a change, you can proceed in two ways:
-
-- You installed a **single key/value** store of your choice:
-
-    - In this case, navigate to the store folder, for example `valkeyrie/store/etcd/v3` and run:
-
-            go test .
-
-    - Finally, test for race conditions using the following command:
-
-            go test -v -race .
-
-- You installed **all key/value** stores and want to run the whole test suite:
-
-    - At the base of the project directory, run:
-
-            go test ./...
-
-    - To test for race conditions, run:
-
-            go test -v -race ./...
-
-### Flush Key/Value pairs and Specific configurations
-
-Once in a while, you may need to flush key/value pairs from your local store installations:
-for example if you stop the tests purposefully with keys still being locked. This section
-describes how to easily start distributed backend storage locally and flush the key/value
-pairs when needed.
-
-#### Consul
-
-To start consul, use the following command:
-
-    consul agent -server -bootstrap -advertise=127.0.0.1 -data-dir /tmp/consul -config-file=/path/to/config.json
-
-This is pointing to a `config.json` file having the following configuration:
-
-    {"session_ttl_min": "1s"}
-
-Finally, to flush the key/value pairs:
-
-    rm -rf /tmp/consul
-
-#### Etcd
-
-To start etcd, use the following command:
+Generally, the tests are using the **default configuration** with the **default port** to connect to a store and run the test suite.
 
-    etcd --data-dir=/tmp/default.etcd --listen-client-urls 'http://0.0.0.0:4001' --advertise-client-urls 'http://localhost:4001'
-
-To flush key/value pairs:
-
-    rm -rf /tmp/default.etcd
-
-#### Zookeeper
-
-To start zookeeper, use:
-
-    zkServer.sh start
-
-Make sure you modify the `zoo.cfg` file to change the default zookeeper directory for testing. For
-example, to have the zookeeper director in the `/tmp` folder, modify the following line:
-
-    dataDir=/tmp/zookeeper
-
-To flush the key/value pairs:
-
-    rm -rf /tmp/zookeeper
-
-#### Redis
-
-To start redis:
-
-    redis-server
-
-For redis, flushing the key/value pairs is as simple as:
-
-    redis-cli flushall
-
-#### Convenient scripts
-
-You can group startup/stop/clean operations for every store with simple scripts:
-
-- **Start**:
-
-```
-#!/bin/bash
-
-nohup etcd --data-dir=/tmp/default.etcd --listen-client-urls 'http://0.0.0.0:4001' --advertise-client-urls 'http://localhost:4001' &>/dev/null &
-nohup consul agent -server -bootstrap -advertise=127.0.0.1 -data-dir /tmp/consul -config-file=/path/to/config.json &>/dev/null &
-zkServer start &>/dev/null &
-nohup redis-server &>/dev/null &
-```
-
-- **Clean**:
-
-```
-#!/bin/bash
-
-rm -rf /tmp/default.etcd
-rm -rf /tmp/consul
-rm -rf /tmp/zookeeper
-redis-cli flushall
-```
-
-- **Stop**:
-
-```
-#!/bin/bash
+To test a change, you can run the test suite with the following command:
 
-pkill consul
-pkill etcd
-pkill -f zookeeper
-pkill redis
+```bash
+make test
 ```
 
 ## Before submitting a change
@@ -174,7 +47,7 @@ the change as soon as possible):
 - **Open an issue** to clearly state the problem. This will be helpful to keep track
 of what needs to be fixed. This also helps triaging and prioritising issues.
 
-- **Run the following command**: `go fmt ./...`, to ensure that your code is properly
+- **Run the following command**: `make validate`, to ensure that your code is properly
 formatted.
 
 - **For non-trivial changes, write a test**: this is to ensure that we don't encounter
@@ -184,16 +57,18 @@ any regression in the future.
 committing a change unless it is a trivial one).
 
 - **Sign-off your commits** using the `-s` flag (you can configure an alias to
-`git  commit` adding `-s` for convenience).
+`git commit` adding `-s` for convenience).
 
 - **Squash your commits** if the pull requests includes many commits that are related.
 This is to maintain a clean history of the change and better identify faulty commits
 if reverting a change is ever needed. We will tell you if squashing your commits is
 necessary.
 
-- **If the change is solving one or more issues listed on the repository**: you can reference
-the issue in your comment with `closes #XXX` or `fixes #XXX`. This will automatically close
-related issues on merging the change.
+- **If the change is solving one or more issues listed on the repository**: you
+can reference the issue in your comment with `closes #XXX` or `fixes #XXX`.
+This will automatically close related issues on merging the change. See
+[Github documentation](https://help.github.com/articles/closing-issues-using-keywords/)
+for more details.
 
 Finally, submit your *Pull Request*.