Merge pull request #1 from cruxstack/dev

feat: add initial bot logic

Author: sgtoj

.editorconfig

@@ -0,0 +1,26 @@
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[{Dockerfile,Dockerfile.*}]
+indent_size = 4
+tab_width = 4
+
+[{Makefile,makefile,GNUmakefile}]
+indent_style = tab
+indent_size = 4
+
+[Makefile.*]
+indent_style = tab
+indent_size = 4
+
+[**/*.{go,mod,sum}]
+indent_style = tab
+indent_size = unset
+
+[**/*.py]
+indent_size = 4

.env.example

@@ -0,0 +1,4 @@
+APP_DEBUG_ENABLED=true
+APP_SLACK_CHANNEL=
+APP_SLACK_TOKEN=
+APP_AWS_CONSOLE_URL=https://us-east-1.console.aws.amazon.com

.github/.dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/release.yaml

@@ -0,0 +1,29 @@
+name: release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Bump Version
+        id: tag_version
+        uses: mathieudutour/github-tag-action@v6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          default_bump: minor
+          custom_release_rules: bug:patch:Fixes,chore:patch:Chores,docs:patch:Documentation,feat:minor:Features,refactor:minor:Refactors,test:patch:Tests,ci:patch:Development,dev:patch:Development
+      - name: Create Release
+        uses: ncipollo/release-action@v1.12.0
+        with:
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          name: ${{ steps.tag_version.outputs.new_tag }}
+          body: ${{ steps.tag_version.outputs.changelog }}

.github/workflows/semantic-check.yaml

@@ -0,0 +1,26 @@
+name: semantic-check
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  main:
+    name: Semantic Commit Message Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - uses: amannn/action-semantic-pull-request@v5.2.0
+        name: Check PR for Semantic Commit Message
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          requireScope: false
+          validateSingleCommit: true

.gitignore

@@ -0,0 +1,63 @@
+# .gitignore
+
+# terraform files
+.terraform.lock.hcl
+.terraform.tfstate.lock.info
+*.tfvars.*
+*.tfstate
+*.tfstate.*.backup
+*.tfstate.backup
+*.tfplan
+*.terraform/
+*.tfvars
+.grunt
+backend.tf.json
+
+# node.js / typescript
+node_modules
+npm-debug.log
+yarn-error.log
+dist
+out
+*.tsbuildinfo
+
+# logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# coverage directories
+coverage
+lib-cov
+
+# docker files
+*.tar
+dockerfile.*.bak
+
+# general
+tmp/
+!**/.gitkeep
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# ides
+.vscode
+.idea
+*.swp
+*.swo
+
+# opa
+bundle.tar.gz
+

README.md

@@ -1,7 +1,5 @@
 # aws-backup-integration-slack-go
 
-**UNDER DEVELOPMENT**
-
 AWS Lambda function that listens to **AWS Backup** events via **Amazon
 EventBridge** and publishes clean, threaded messages to Slack.
 
@@ -26,11 +24,11 @@ EventBridge** and publishes clean, threaded messages to Slack.
 ### Steps
 
 ```bash
-git clone https://github.com/cruxstack/aws-backup-integration-slack.git
-cd aws-backup-integration-slack
+git clone https://github.com/cruxstack/aws-backup-integration-slack-go.git
+cd aws-backup-integration-slack-go
 
 # build static Linux binary for lambda
-GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o bootstrap
+GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -C cmd/lambda -o ../../bootstrap
 
 # package
 zip deployment.zip bootstrap
@@ -56,11 +54,18 @@ zip deployment.zip bootstrap
    * Upload `deployment.zip`
    * Set environment variables above
 3. **EventBridge rule**
-   ```json
-   {
-     "source": ["aws.backup"],
-     "detail-type": ["Backup Job State Change"]
-   }
+    ```json
+    {
+      "source": ["aws.backup"],
+      "detail-type": [
+        "Backup Job State Change",
+        "Backup Plan State Change",
+        "Backup Vault State Change",
+        "Copy Job State Change",
+        "Region Setting State Change",
+        "Restore Job State Change"
+      ]
+    }
    ```
    Target: the Lambda function.
 4. **Slack App**
@@ -75,7 +80,7 @@ zip deployment.zip bootstrap
 
 ```bash
 cp .env.example .env # edit the values
-go run .
+go run -C cmd/sample .
 ```
 
 The sample runner replays `fixtures/samples.json` and posts to Slack exactly as

assets/slack/manifest.json

@@ -0,0 +1,28 @@
+{
+    "display_information": {
+        "name": "AWS Backup",
+        "description": "AWS Backup Bot",
+        "background_color": "#00802f"
+    },
+    "features": {
+        "bot_user": {
+            "display_name": "AWS Backup",
+            "always_online": false
+        }
+    },
+    "oauth_config": {
+        "scopes": {
+            "bot": [
+                "channels:join",
+                "channels:read",
+                "chat:write.public",
+                "chat:write"
+            ]
+        }
+    },
+    "settings": {
+        "org_deploy_enabled": false,
+        "socket_mode_enabled": false,
+        "token_rotation_enabled": false
+    }
+}

cmd/lambda/main.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"log"
+	"sync"
+
+	awsevents "github.com/aws/aws-lambda-go/events"
+	"github.com/aws/aws-lambda-go/lambda"
+	"github.com/cruxstack/aws-backup-slack-integration-go/internal/app"
+)
+
+/*
+   Lambda wrapper helpers
+*/
+
+var (
+	once    sync.Once
+	a       *app.App
+	initErr error
+)
+
+// LambdaHandler satisfies aws-lambda-go.
+func LambdaHandler(_ context.Context, evt awsevents.CloudWatchEvent) error {
+	once.Do(func() {
+		cfg, err := app.NewConfig()
+		if err != nil {
+			initErr = err
+			return
+		}
+		a = app.New(cfg)
+	})
+
+	if initErr != nil {
+		// returning (not panic) preserves clean CW metrics
+		return initErr
+	}
+
+	if a.Config.DebugEnabled {
+		j, _ := json.Marshal(evt)
+		log.Print(string(j))
+	}
+
+	return a.Process(evt)
+}
+
+func main() {
+	lambda.Start(LambdaHandler)
+}

cmd/sample/main.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"encoding/json"
+	"log"
+	"os"
+	"path/filepath"
+
+	awsevents "github.com/aws/aws-lambda-go/events"
+	"github.com/joho/godotenv"
+
+	"github.com/cruxstack/aws-backup-slack-integration-go/internal/app"
+)
+
+func main() {
+	envpath := filepath.Join("..", "..", ".env")
+	log.Print(envpath)
+	if _, err := os.Stat(envpath); err == nil {
+		_ = godotenv.Load(envpath)
+	}
+
+	cfg, err := app.NewConfig()
+	if err != nil {
+		log.Fatal(err)
+	}
+	a := app.New(cfg)
+
+	path := filepath.Join("..", "..", "fixtures", "samples.json")
+	raw, err := os.ReadFile(path)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	var evts []awsevents.CloudWatchEvent
+	if err := json.Unmarshal(raw, &evts); err != nil {
+		log.Fatal(err)
+	}
+
+	for _, e := range evts {
+		if err := a.Process(e); err != nil {
+			log.Fatalf("process id=%s: %v", e.ID, err)
+		}
+	}
+}