Resolve all lint issues, add e2e test on CI

.github/workflows/branch-build.yml

@@ -76,7 +76,7 @@ jobs:
         with:
           go-version-file: 'go.mod'
           cache: true
-            
+
       - name: Install Helm
         uses: azure/setup-helm@v1
         with:
@@ -103,13 +103,24 @@ jobs:
            --set image.repository="${IMAGE_REPOSITORY}" \
            --set image.tag="${IMAGE_TAG}" \
 
+      - name: Install GoReleaser
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          install-only: true
+          version: latest
+
+      - name: Build all plugins into dist directory
+        run: |
+          make build-plugins
+
       - name: Run ${{ matrix.integration }} tests
         env:
           SLACK_TESTER_APP_TOKEN: ${{ secrets.SLACK_TESTER_APP_TOKEN }}
           SLACK_ADDITIONAL_CONTEXT_MESSAGE: "Branch test - commit SHA: ${GITHUB_SHA} - https://github.com/kubeshop/botkube/commit/${GITHUB_SHA}"
           DISCORD_TESTER_APP_TOKEN: ${{ secrets.DISCORD_TESTER_APP_TOKEN }}
           DISCORD_GUILD_ID: ${{ secrets.DISCORD_GUILD_ID }}
           DISCORD_ADDITIONAL_CONTEXT_MESSAGE: "Branch test - commit SHA: ${GITHUB_SHA} - https://github.com/kubeshop/botkube/commit/${GITHUB_SHA}"
+          PLUGINS_BINARIES_DIRECTORY: ${{ github.workspace }}/dist
         run: |
           KUBECONFIG=$(k3d kubeconfig write ${{ matrix.integration }}-test-cluster) \
             make test-integration-${{ matrix.integration }}

.github/workflows/pr-build.yaml

@@ -120,6 +120,27 @@ jobs:
 
           ENDOFFILE
 
+  check-generated-resources:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Run generating gRPC resources
+        run: make gen-grpc-resources
+
+      - name: Detect git changes
+        run: |
+          if [[ $(git diff --stat) != '' ]]; then
+            echo -e '❌ \033[0;31mGenerated gRPC resources are outdated. Run 'make gen-grpc-resources'.\033[0m'
+            git diff --color
+            exit 1
+          else
+            echo '✔ No issues detected. Have a nice day :-)'
+          fi
+
   integration-tests:
     name: Integration tests
     runs-on: ubuntu-latest
@@ -174,13 +195,24 @@ jobs:
             --set image.repository="${IMAGE_REPOSITORY}" \
             --set image.tag="${IMAGE_TAG}" \
 
+      - name: Install GoReleaser
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          install-only: true
+          version: latest
+
+      - name: Build all plugins into dist directory
+        run: |
+          make build-plugins
+
       - name: Run ${{ matrix.integration }} tests
         env:
           SLACK_TESTER_APP_TOKEN: ${{ secrets.SLACK_TESTER_APP_TOKEN }}
           SLACK_ADDITIONAL_CONTEXT_MESSAGE: "Pull request: ${PR_NUMBER} - https://github.com/kubeshop/botkube/pull/${PR_NUMBER}"
           DISCORD_TESTER_APP_TOKEN: ${{ secrets.DISCORD_TESTER_APP_TOKEN }}
           DISCORD_GUILD_ID: ${{ secrets.DISCORD_GUILD_ID }}
           DISCORD_ADDITIONAL_CONTEXT_MESSAGE: "Pull request: ${PR_NUMBER} - https://github.com/kubeshop/botkube/pull/${PR_NUMBER}"
+          PLUGINS_BINARIES_DIRECTORY: ${{ github.workspace }}/dist
         run: |
           KUBECONFIG=$(k3d kubeconfig write ${{ matrix.integration }}-test-cluster) \
             make test-integration-${{ matrix.integration }}

Makefile

@@ -1,5 +1,5 @@
 .DEFAULT_GOAL := build
-.PHONY: container-image test test-integration-slack test-integration-discord build pre-build publish lint lint-fix go-import-fmt system-check save-images load-and-push-images
+.PHONY: container-image test test-integration-slack test-integration-discord build pre-build publish lint lint-fix go-import-fmt system-check save-images load-and-push-images gen-grpc-resources build-plugins
 
 # Show this help.
 help:
@@ -69,6 +69,10 @@ system-check:
 	echo 'System information checks passed.'; \
 	fi ;
 
+# Generate gRPC Go code for client and server.
+gen-grpc-resources:
+	@./hack/gen-grpc-resources.sh
+
 # Pre-build checks
 pre-build: system-check
 

cmd/botkube/main.go

@@ -99,9 +99,8 @@ func run() error {
 
 	errGroup, ctx := errgroup.WithContext(ctx)
 
-	// FIXME: collect enabled executors
-	// it can be done by creating collector for enabled bindings and shared with router
-	pluginManager := plugin.NewManager(logger, conf.Plugins, conf.Executors)
+	enabledPluginExecutors := plugin.GetAllEnabledAndUsedPluginExecutors(conf)
+	pluginManager := plugin.NewManager(logger, conf.Plugins, enabledPluginExecutors)
 
 	err = pluginManager.Start(ctx)
 	if err != nil {

cmd/executor/echo/README.md

@@ -0,0 +1,11 @@
+# Echo executor
+
+Echo is the example Botkube executor used during [e2e tests](../../../test/e2e).
+
+## Configuration parameters
+
+The Echo configuration should be specified in YAML format. It accepts such parameters:
+
+```yaml
+changeResponseToUpperCase: true # default is 'false'.
+```

cmd/executor/echo/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"context"
+	"strings"
 
 	"github.com/hashicorp/go-plugin"
 
@@ -10,10 +11,27 @@ import (
 
 const pluginName = "echo"
 
+// Config holds executor configuration.
+type Config struct {
+	ChangeResponseToUpperCase bool
+}
+
+// EchoExecutor implements Botkube executor plugin
 type EchoExecutor struct{}
 
+// Execute returns a given command as response.
 func (EchoExecutor) Execute(_ context.Context, req *executor.ExecuteRequest) (*executor.ExecuteResponse, error) {
-	return &executor.ExecuteResponse{Data: req.Command}, nil
+	// TODO: in request we should receive the executor configuration.
+	cfg := Config{}
+
+	data := req.Command
+	if cfg.ChangeResponseToUpperCase {
+		data = strings.ToUpper(data)
+	}
+
+	return &executor.ExecuteResponse{
+		Data: data,
+	}, nil
 }
 
 func main() {

hack/fmt-imports.sh

@@ -9,7 +9,7 @@ set -E         # needs to be set if we want the ERR trap
 
 CURRENT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 REPO_ROOT_DIR=$(cd "${CURRENT_DIR}/.." && pwd)
-GOIMPORTS_REVISER_VERSION=2.5.3
+GOIMPORTS_REVISER_VERSION=3.3.0
 
 host::os() {
   local host_os
@@ -86,12 +86,9 @@ imports::format() {
   echo "Executing goimports-reviser..."
   pushd "$REPO_ROOT_DIR" > /dev/null
 
-  paths=$(find . -name '*.go')
-
-  # TODO: Consider to run it in parallel to speed up the execution.
-  for file in $paths; do
-    goimports-reviser -file-path "$file" -rm-unused -local github.com/kubeshop/botkube -project-name github.com/kubeshop/botkube
-  done
+  goimports-reviser -rm-unused -project-name github.com/kubeshop/botkube -recursive ./pkg
+  goimports-reviser -rm-unused -project-name github.com/kubeshop/botkube -recursive ./cmd
+  goimports-reviser -rm-unused -project-name github.com/kubeshop/botkube -recursive ./internal
 
   popd > /dev/null
 }

hack/goreleaser.sh

@@ -94,12 +94,7 @@ build() {
 
 build_plugins() {
   prepare
-  docker run --rm --privileged \
-    -v $PWD:/go/src/github.com/kubeshop/botkube \
-    -v /var/run/docker.sock:/var/run/docker.sock \
-    -w /go/src/github.com/kubeshop/botkube \
-    -e ANALYTICS_API_KEY="${ANALYTICS_API_KEY}" \
-    goreleaser/goreleaser build -f .goreleaser.plugin.yaml --rm-dist --snapshot
+  goreleaser build -f .goreleaser.plugin.yaml --rm-dist --snapshot
 }
 
 build_single() {

internal/plugin/bindings.go

@@ -0,0 +1,65 @@
+package plugin
+
+import (
+	"github.com/kubeshop/botkube/pkg/config"
+)
+
+// GetAllEnabledAndUsedPluginExecutors returns the list of all plugins executors that are both enabled and bind to at
+// least one communicator that is also enabled.
+func GetAllEnabledAndUsedPluginExecutors(cfg *config.Config) []string {
+	// Collect all used executor bindings
+	bindExecutors := map[string]struct{}{}
+	collect := func(channels config.IdentifiableMap[config.ChannelBindingsByName]) {
+		for _, bindings := range channels {
+			for _, name := range bindings.Bindings.Executors {
+				bindExecutors[name] = struct{}{}
+			}
+		}
+	}
+
+	for _, commGroupCfg := range cfg.Communications {
+		if commGroupCfg.Slack.Enabled {
+			collect(commGroupCfg.Slack.Channels)
+		}
+
+		if commGroupCfg.SocketSlack.Enabled {
+			collect(commGroupCfg.SocketSlack.Channels)
+		}
+
+		if commGroupCfg.Mattermost.Enabled {
+			collect(commGroupCfg.Mattermost.Channels)
+		}
+
+		if commGroupCfg.Teams.Enabled {
+			for _, name := range commGroupCfg.Teams.Bindings.Executors {
+				bindExecutors[name] = struct{}{}
+			}
+		}
+
+		if commGroupCfg.Discord.Enabled {
+			for _, bindings := range commGroupCfg.Discord.Channels {
+				for _, name := range bindings.Bindings.Executors {
+					bindExecutors[name] = struct{}{}
+				}
+			}
+		}
+	}
+
+	// Collect all executors that are both enabled and bind to at least one communicator that is enabled.
+	var usedExecutorPlugins []string
+	for groupName, groupItems := range cfg.Executors {
+		for name, executor := range groupItems.Plugins {
+			if !executor.Enabled {
+				continue
+			}
+			_, found := bindExecutors[groupName]
+			if !found {
+				continue
+			}
+
+			usedExecutorPlugins = append(usedExecutorPlugins, name)
+		}
+	}
+
+	return usedExecutorPlugins
+}

internal/plugin/index.go

@@ -1,16 +1,21 @@
 package plugin
 
+// Type represents the plugin type.
 type Type string
 
 const (
-	TypeSource   Type = "source"
+	// TypeSource represents the source plugin.
+	TypeSource Type = "source"
+	// TypeExecutor represents the executor plugin.
 	TypeExecutor Type = "executor"
 )
 
 type (
+	// Index defines the plugin repository index.
 	Index struct {
 		Entries []IndexEntry
 	}
+	// IndexEntry defines the plugin definition.
 	IndexEntry struct {
 		Name        string
 		Type        Type
@@ -19,8 +24,3 @@ type (
 		Links       []string
 	}
 )
-
-type Plugin struct {
-	Name    string
-	Version string
-}