chore: added Slack command

.dockerignore

@@ -0,0 +1,17 @@
+*.csv
+spectromate
+.DS_STORE
+node_modules/
+static/
+.github/
+node_modules/
+package*.json
+.releaserc.yml
+test/
+*.csv
+.husky/
+CHANGELOG
+README.md
+data/
+terraform/
+docs/

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Describe the Change
+
+This PR .....
+
+## Review Changes
+
+
+🎫 [Jira Ticket]()

.github/workflows/gitleaks.yaml

@@ -0,0 +1,36 @@
+name: GitLeaks
+on: [pull_request]
+
+concurrency:
+  group: gitleaks-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  gitleaks-scan:
+    runs-on: ubuntu-latest
+    container:
+      image: gcr.io/spectro-dev-public/bulwark/gitleaks:latest
+      env:
+        REPO: ${{ github.event.repository.name }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITLEAKS_CONFIG: config.toml
+    steps:
+
+      - name: run-bulwark-gitleaks-scan
+        shell: sh
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+        run: /workspace/bulwark -name CodeSASTGitLeaks -target $REPO -tags "branch:$BRANCH,options:--log-opts origin..HEAD"
+
+      - name: check-result
+        shell: sh
+        run: |
+          resultPath=./$REPO/gitleaks.json
+          cat $resultPath | grep -v \"Match\"\: | grep -v \"Secret\"\:
+          total_failed_tests=`cat $resultPath | grep \"Fingerprint\"\: | wc -l`
+          if [ "$total_failed_tests" -gt 0 ]; then
+            echo "GitLeaks validation check failed with above findings..."
+            exit 1
+          else 
+            echo "GitLeaks validation check passed"
+          fi

.github/workflows/test.yaml

@@ -0,0 +1,129 @@
+name: Test & Validate
+
+on:
+  pull_request:
+    types: ['synchronize', 'opened', 'reopened', 'ready_for_review']
+    branches:
+    - main
+
+env:
+  GITHUB_TOKEN: ${{ github.token }}
+  MENDABLE_API_KEY: ${{secrets.MENDABLE_API_KEY}}
+  SLACK_SIGNING_SECRET: ${{secrets.SLACK_SIGNING_SECRET}}
+
+
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    if: ${{ !github.event.pull_request.draft }}
+    steps:
+    # If the condition above is not met, aka, the PR is not in draft status, then this step is skipped.
+    # Because this step is part of the critical path, omission of this step will result in remaining CI steps not gettinge executed.
+    # As of 8/8/2022 there is now way to enforce this beahvior in GitHub Actions CI.
+      - run: exit 0
+
+
+  linting:
+    needs: [run-ci]
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+        check-latest: true
+
+    - name: Lint Internal Package
+      uses: golangci/golangci-lint-action@v3
+      with:
+        args: --verbose --timeout 5m
+
+  test:
+    name: Test
+    needs: [run-ci,linting]
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+        check-latest: true
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v3
+
+    - name: Go Tests
+      run: |
+        go test -race ./...
+
+  compile:
+    name: Compile validation
+    needs: [run-ci,linting]
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+        check-latest: true
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v3
+
+    - name: Run golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:  
+        args: -v
+
+    - name: build
+      run: |
+        go build -race -ldflags="-X 'spectrocloud.com/spectromate/cmd.VersionString=1.0.0'" -o=spectromate -v
+
+  Docker:
+    needs: [run-ci,linting,test,compile]
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - uses: actions/setup-go@v4
+      with:
+        go-version: '1.20'
+        check-latest: true
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+
+
+    - name: Login to GHCR
+      uses: docker/login-action@v1
+      with:
+        registry: ghcr.io
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and Push Docker Image
+      uses: docker/build-push-action@v4.0.0
+      with:
+        context: .
+        platforms: linux/amd64,linux/arm64
+        push: true
+        tags: ghcr.io/${{ github.repository }}:dev
+        build-args: |
+          VERSION=1.0.0

.gitignore

@@ -5,6 +5,9 @@
 *.so
 *.dylib
 
+# Environment variables
+.env
+
 # Test binary, built with `go test -c`
 *.test
 
@@ -13,3 +16,14 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+data/
+.DS_STORE
+node_modules/
+.terraform/
+*.tfstate
+*.tfstate.*.backup
+*.tfstate.backup
+spectromate
+backend.tf
+redis/

Dockerfile

@@ -0,0 +1,23 @@
+FROM golang:1.20.3-alpine3.17 as builder
+
+LABEL org.opencontainers.image.source="http://spectrocloud.com/spectromate"
+LABEL org.opencontainers.image.description "An API server with features to support Slack bots integration."
+
+ARG VERSION
+
+ADD ./ /source
+RUN cd /source && \
+adduser -H -u 1002 -D appuser appuser && \
+go build -ldflags="-X 'spectrocloud.com/spectromate/cmd.VersionString=${VERSION}'" -o spectromate -v
+
+FROM alpine:latest
+
+COPY --from=builder /etc/passwd /etc/passwd
+COPY --from=builder /etc/group /etc/group
+COPY --from=builder --chown=appuser:appuser  /source/spectromate /usr/bin/
+
+RUN apk -U upgrade && apk add bash jq git --no-cache && mkdir /packs && chown -R appuser:appuser /packs && \
+mkdir -p /var/log/spectromate && chown -R appuser:appuser /var/log/spectromate
+USER appuser
+
+CMD ["/usr/bin/spectromate", ">>", "/var/log/spectromate.log", "2>&1"]

Makefile

@@ -0,0 +1,23 @@
+start:
+	@echo "Starting the application and ngrok..."
+	@docker compose up --detach
+	@ngrok http 3000 --log-level=debug > /dev/null & sleep 2
+	@echo "Ngrok URL: $$(curl -s localhost:4040/api/tunnels | jq -r '.tunnels[0].public_url')"
+
+
+stop:
+	@echo "Stopping the application and ngrok"
+	docker compose down
+	pkill ngrok
+
+server:
+	@echo "Starting the server..."
+	go run main.go
+
+
+make init: 
+	@echo "Installing dependencies..."
+	go mod download
+	go install github.com/golang/mock/mockgen@v1.6.0
+	~/go/bin/mockgen -source=internal/cache.go -destination=mock/mock_cache.go -package=mock
+

README.md

@@ -1,2 +1,73 @@
-# docs-slack-bot
-The home for the Spectro Cloud Slack Bot
+# SpectroMate
+
+
+<p align="center">The home of SpectroMate :robot: </p>
+
+<p align="center">
+  <img src="/static/images/mascot.png" alt="drawing" width="250"/>
+</p>
+
+
+## Overview 👩‍🚀 🧑‍🚀 🧑🏿‍🚀
+
+SpectroMate is an API server with extended functionality designed for Slack integration in the form of a bot. You can use SpectroMate to handle [slash commands](https://api.slack.com/interactivity/slash-commands), and [message actions](https://api.slack.com/reference/interaction-payloads). You can also use SpectroMate to handle non-slack-related events by creating API endpoints for other purposes. 
+
+SpectroMate is designed for deployment in [Palette](https://console.spectrocloud.com) using the Palette Dev Engine (PDE). Using simplifies the management and deployment of SpectroMate.
+
+---
+
+## Getting Started 🚀
+
+To get started with Spectromate follow the steps outlined in the [Getting Started](./docs/getting-started.md) guide.
+
+---
+
+## API Endpoints 🕹️
+
+The following endpoints are available.
+
+| Description                                               | Endpoint           |
+| ----------------------------------------------------------|-------------------|
+| Used for health checks by external resources.             | `/health`          |
+| A slack endpoint that can be used to handle slash commands.| `/slack`           |
+| A slack endpoint for handling slack message actions.      | `/slack/actions`   |
+
+
+## Slack Commands 🛠️
+
+The following Slack commands are available.
+
+| Description                                               | Command           |
+| ----------------------------------------------------------|-------------------|
+| Displays information to the user for how to use SpectroMate. Invalid commands return the help response.             | `/help`          |
+| Used to query the Mendable and ask documentation questions to a trained model.| `/ask`           |
+| Same as the `/ask` but responses are only visible to the user versus the entire channel.      | `/pask`   |
+
+
+## Slack Actions 🪡
+
+Spectromate supports the following actions.
+
+| Description                                               | Action           |
+| ----------------------------------------------------------|-------------------|
+| Handles the possitive feedback button and submits the feedback to Mendable.  | `ask_model_positive_feedback` |
+| Handles the negavtive feedback button and submits the feedback to Mendable.| `ask_model_negative_feedback` |
+
+
+## Architecture
+
+The following is an architectural overview of SpectroMate. 
+
+![An architecture diagram with all the components that support SpectroMate](./static/images/infrastructure-architecture.png)
+
+
+## Supported Features and Limitations
+
+|Action| Supported | Notes |
+|---|---|---|
+| Slash command| ✅ | Supported through the `/slack` endpoint.|
+| Message buttons | ✅| Supported through the `/slack/actions` endpoint.|
+| Mentions | ❌ | Currently unavailable. |
+| Health checks | ✅ | Supported through the `/health` endpoint.|
+| Verify Slack signature| ✅ | Verification of Slack signature is applied to all Slack endpoints.|
+| Metrics | ❌ | Currently unavailable. |

docker-compose.yaml

@@ -0,0 +1,18 @@
+version: '3.8'
+services:
+  redis:
+    image: redis:7.0.5-alpine3.17
+    ports:
+      - "6379:6379"
+    command: redis-server --bind 0.0.0.0
+    volumes:
+      - ./redis/redis.conf:/usr/local/etc/redis/redis.conf
+      - ./data:/data
+    restart: always
+  redis-cli:
+    image: redis:7.0.5-alpine3.17
+    depends_on:
+      - redis
+    entrypoint: redis-cli
+    tty: true
+    restart: always