Add DEVELOPER.md

go/DEVELOPER.md

@@ -0,0 +1,205 @@
+# Developer Guide
+
+This document describes how to set up your development environment to build and test the GLIDE for Redis Go wrapper.
+
+### Development Overview
+
+The GLIDE for Redis Go wrapper consists of both Go and Rust code. The Go and Rust components communicate in two ways:
+1. using the [protobuf](https://github.com/protocolbuffers/protobuf) protocol.
+2. using shared C objects. [cgo](https://pkg.go.dev/cmd/cgo) is used to interact with the C objects from Go code.
+
+### Build from source
+
+#### Prerequisites
+
+Software Dependencies
+
+-   Go
+-   GNU Make
+-   git
+-   GCC
+-   pkg-config
+-   protoc (protobuf compiler) >= v3.20.0
+-   openssl
+-   openssl-dev
+-   rustup
+
+
+**Dependencies installation for Ubuntu**
+
+```bash
+sudo apt update -y
+sudo apt install -y git gcc pkg-config openssl libssl-dev unzip make
+# Install Go
+sudo snap install go --classic
+export PATH="$PATH:$HOME/go/bin"
+# Install rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source "$HOME/.cargo/env"
+# Check that the Rust compiler is installed
+rustc --version
+# Install protobuf compiler
+PB_REL="https://github.com/protocolbuffers/protobuf/releases"
+curl -LO $PB_REL/download/v3.20.3/protoc-3.20.3-linux-x86_64.zip
+unzip protoc-3.20.3-linux-x86_64.zip -d $HOME/.local
+export PATH="$PATH:$HOME/.local/bin"
+# Check that the protobuf compiler is installed
+protoc --version
+```
+
+**Dependencies installation for CentOS**
+
+```bash
+sudo yum update -y
+sudo yum install -y git gcc pkgconfig openssl openssl-devel unzip wget tar
+# Install Go
+wget https://go.dev/dl/go1.22.0.linux-amd64.tar.gz
+sudo tar -C /usr/local -xzf go1.22.0.linux-amd64.tar.gz
+export PATH="$PATH:/usr/local/go/bin"
+export PATH="$PATH:$HOME/go/bin"
+# Install rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source "$HOME/.cargo/env"
+# Check that the Rust compiler is installed
+rustc --version
+# Install protobuf compiler
+PB_REL="https://github.com/protocolbuffers/protobuf/releases"
+curl -LO $PB_REL/download/v3.20.3/protoc-3.20.3-linux-x86_64.zip
+unzip protoc-3.20.3-linux-x86_64.zip -d $HOME/.local
+export PATH="$PATH:$HOME/.local/bin"
+# Check that the protobuf compiler is installed
+protoc --version
+```
+
+**Dependencies installation for MacOS**
+
+```bash
+brew update
+brew install go make git gcc pkgconfig protobuf@3 openssl
+export PATH="$PATH:$HOME/go/bin"
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+source "$HOME/.cargo/env"
+# Check that the Rust compiler is installed
+rustc --version
+```
+
+#### Building and installation steps
+
+Before starting this step, make sure you've installed all software requirements.
+
+1. Clone the repository:
+    ```bash
+    VERSION=0.1.0 # You can modify this to other released version or set it to "main" to get the unstable branch
+    git clone --branch ${VERSION} https://github.com/aws/glide-for-redis.git
+    cd glide-for-redis
+    ```
+2. Initialize git submodule:
+    ```bash
+    git submodule update --init --recursive
+    ```
+3. Install build dependencies:
+    ```bash
+    cd go
+    make install-build-tools
+    ```
+4. Build the Go wrapper:
+    ```bash
+    make build
+    ```
+5. Run tests:
+    1. Ensure that you have installed redis-server and redis-cli on your host. You can find the Redis installation guide at the following link: [Redis Installation Guide](https://redis.io/docs/install/install-redis/install-redis-on-linux/).
+    2. Execute the following command from the go folder:
+        ```bash
+        go test -race ./...
+        ```
+
+-   Install Go development tools with:
+
+    ```bash
+    make install-dev-tools
+    ```
+
+### Test
+
+To run tests, use the following command:
+
+```bash
+go test -race ./...
+```
+
+For more detailed test output, add the `-v` flag:
+
+```bash
+go test -race ./... -v
+```
+
+To execute a specific test, include `-run <test_name>`. For example:
+
+```bash
+go test -race ./... -run TestConnectionRequestProtobufGeneration_allFieldsSet -v
+```
+
+### Submodules
+
+After pulling new changes, ensure that you update the submodules by running the following command:
+
+```bash
+git submodule update
+```
+
+### Generate protobuf files
+
+During the initial build, Go protobuf files were created in `go/protobuf`. If modifications are made to the protobuf definition files (.proto files located in `glide-core/src/protobuf`), it becomes necessary to regenerate the Go protobuf files. To do so, run:
+
+```bash
+make generate-protobuf
+```
+
+
+### Linters
+
+Development on the Go wrapper may involve changes in either the Go or Rust code. Each language has distinct linter tests that must be passed before committing changes.
+
+#### Language-specific Linters
+
+**Go:**
+
+-   gofumpt
+-   staticcheck
+-   golines
+
+**Rust:**
+
+-   clippy
+-   fmt
+
+#### Running the linters
+
+Run from the main `/go` folder
+
+1. Go
+    ```bash
+    make install-dev-tools
+    make lint
+    ```
+2. Rust
+    ```bash
+    rustup component add clippy rustfmt
+    cargo clippy --all-features --all-targets -- -D warnings
+    cargo fmt --manifest-path ./Cargo.toml --all
+    ```
+
+#### Fixing lint formatting errors
+
+The following command can be used to fix Go formatting errors reported by gofumpt or golines. Note that golines does not always format comments well if they surpass the max line length (127 characters).
+
+Run from the main `/go` folder
+
+```bash
+make format
+```
+
+### Recommended extensions for VS Code
+
+-   [Go](https://marketplace.visualstudio.com/items?itemName=golang.Go)
+-   [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)