test/

E2E Tests

This directory contains E2E tests. The tests instrument both Slack and Discord using a tester app and tester bot respectively.

Basically, our testers listen to events sent from Botkube in a test cluster. And, the testers also trigger commands for Botkube to execute.

On Kubernetes, the E2E tests are self-contained. They just require a Botkube installation on a cluster as highlighted in the instructions below.

General prerequisites

• Kubernetes cluster (e.g. local one created with k3d)

Testing Slack

Prerequisites

• Botkube bot app configured for a Slack workspace according to the instruction
• Botkube tester app configured according to the instruction

Configure Tester Slack application

NOTE: This is something you need to do only once. Once the tester app is configured, you can use its token for running integration tests as many times as you want.

1. Create new Slack Application on this page

2. Use "From an app manifest" option

3. Copy and paste this manifest:

   display_information:
     name: Botkube tester
   features:
     bot_user:
       display_name: Tester
       always_online: false
   oauth_config:
     scopes:
       bot:
         - channels:join
         - channels:manage
         - chat:write
         - users:read
         - channels:history
   settings:
     org_deploy_enabled: false
     socket_mode_enabled: false
     token_rotation_enabled: false
   

4. Install this app into your workspace

5. Navigate to the OAuth & Permissions section

6. Copy the Bot User OAuth Token and save it for later.

   You can already export it as environment variable for Botkube installation or running the tests:

   export SLACK_TESTER_APP_TOKEN="{Botkube tester app token}
   

Testing Discord

Prerequisites

• A Discord server available, create one if required.
• Botkube bot app configured for a Discord server according to the instruction

  NOTE: Please name the app botkube and skip step 11 as it's not required.

• Botkube tester bot app configured according to the instruction

Configure Tester Discord bot application

NOTE: This is something you need to do only once. Once the tester app is configured, you can use its token for running integration tests as many times as you want.

1. Create a new Discord app here.
2. Name the app: botkube_tester.
3. Navigate to the Bot page and Click Add Bot to add a Discord Bot to your application.
4. Click the Reset Token button.
5. Copy the Token and export it as the DISCORD_TESTER_APP_TOKEN environment variable.

   export DISCORD_TESTER_APP_TOKEN="{Botkube Discord tester app bot token}"
   

6. Go to the OAuth2 page.
7. Select SCOPES as bot.
8. Select BOT PERMISSIONS as:
   • Manage Channels.
   • Read Messages/View Channels.
   • Send Messages.
   • Manage Messages.
   • Embed Links.
   • Attach Files.
   • Read Message History.
   • Mention Everyone.
9. Generate the URL using the OAuth2 URL Generator available under the OAuth2 section to add bot to your Discord server.
10. Copy and Paste the generated URL in a new tab, select the discord server to which you want to add the bot, click Continue and Authorize Bot addition.
11. Go back to the Discord screen and navigate to the Bot page.
12. Toggle PUBLIC BOT to OFF and MESSAGE CONTENT INTENT to ON.
13. Navigate back to the Discord server where you've installed tester app bot.
14. Find the name of the server in the top left.
15. Right click and select CopyID to copy the server ID. This is the DISCORD_GUILD_ID that we'll need to run tests against the server.

export DISCORD_GUILD_ID="{Botkube Discord tester guildID}"

Install Botkube

Use environment vars for the specific platform (Slack or Discord or both) when running your E2E tests.

For example, if you're only running Discord tests, you can omit env var prefixed with SLACK_...

1. Export required environment variables:

   #
   # Environment variables for running Botkube
   #
   
   export SLACK_BOT_TOKEN="{token for your configured Slack Botkube app}" # WARNING: Token for Botkube Slack bot, not the Tester!
   
   export DISCORD_BOT_ID="{Botkube Discord bot ClientID}" # WARNING: ClientID for Botkube Discord bot, not the Tester bot!
   export DISCORD_BOT_TOKEN="{token for your configured Discord Botkube bot}" # WARNING: Token for Botkube Discord bot, not the Tester!
   
   export IMAGE_REGISTRY="ghcr.io"
   export IMAGE_REPOSITORY="kubeshop/botkube"
   export IMAGE_TAG="v9.99.9-dev"
   
   #
   # Environment variables for running integration tests
   #
   export SLACK_TESTER_APP_TOKEN="{Botkube Slack tester app token}" # WARNING: Token for Tester, not the Botkube Slack bot!
   export DISCORD_TESTER_APP_TOKEN="{Botkube Discord tester app token}" # WARNING: Token for Tester, not the Botkube Discord bot!
   export DISCORD_GUILD_ID="{Discord server ID}" # Where the tests will
   
   #
   # Optional environment variables
   #
   export SLACK_TESTER_NAME="{Name of Botkube SLACK tester app}" # WARNING: tester name defaults to `tester` when a name is not provided for local test runs!
   export DISCORD_TESTER_NAME="{Name of Botkube DISCORD tester app}" # WARNING: tester name defaults to `tester` when a name is not provided for local test runs!
   

2. Install Botkube using Helm chart:

   helm install botkube --namespace botkube ./helm/botkube --wait --create-namespace \
     -f ./helm/botkube/e2e-test-values.yaml \
     --set communications.default-group.slack.token="${SLACK_BOT_TOKEN}" \
     --set communications.default-group.discord.token="${DISCORD_BOT_TOKEN}" \
     --set communications.default-group.discord.botID="${DISCORD_BOT_ID}" \
     --set image.registry="${IMAGE_REGISTRY}" \
     --set image.repository="${IMAGE_REPOSITORY}" \
     --set image.tag="${IMAGE_TAG}"
   

Compile plugins

We test also the Botkube plugins system. To compile Botkube plugins, run:

OUTPUT_MODE="archive" make build-plugins

By default, built plugins' binaries are available under plugin-dist directory. The e2e framework builds the plugins index file dynamically and starts the HTTP server that is later accessible from the k3d cluster.

To override default settings, export following environment variables:

export PLUGINS_BINARIES_DIRECTORY="./plugin-dist"
export PLUGINS_SERVER_HOST="http://host.k3d.internal" # on K3d enabling you to access your host system by referring to it as host.k3d.internal
export PLUGINS_SERVER_PORT="3000"

Run the tests

1. Ensure the environment variables for your target platforms are exported:

   export KUBECONFIG=/Users/$USER/.kube/config # set custom path if necessary
   export SLACK_TESTER_APP_TOKEN="{Botkube Slack tester app token}" # WARNING: Token for Tester, not the Botkube Slack bot!
   export DISCORD_TESTER_APP_TOKEN="{Botkube Discord tester app token}" # WARNING: Token for Tester, not the Botkube Discord bot!
   export DISCORD_GUILD_ID="{Discord server ID}"
   

2. Run the tests for Slack:

   make test-integration-slack
   

3. Run the tests for Discord:

   make test-integration-discord
   

Clear botkube-system ConfigMap between test runs

Botkube tracks whether the initial help message was sent or not to minimise spam. This is tracked in a botkube-system ConfigMap.

After running the tests for an e2e target, e.g. make test-integration-slack, please ensure this ConfigMap is removed before rerunning the test against another target, e.g. make test-integration-discord.

kubectl delete cm botkube-system -n botkube # or the namespace where Botkube is installed

If you don't remove the ConfigMap, any e2e tests looking to verify that a help message is displayed will error. This also stops the rest of the e2e tests from running.