Merge branch 'main' into dependabot/maven/org.mockito-mockito-core-5.21.0

Author: zimeg

.github/workflows/dependencies.yml

@@ -0,0 +1,29 @@
+name: Merge updates to dependencies
+on:
+  pull_request:
+jobs:
+  dependabot:
+    name: "@dependabot"
+    if: github.event.pull_request.user.login == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Collect metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@08eff52bf64351f401fb50d4972fa95b9f2c2d1b # v2.4.0
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Approve
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor'
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Automerge
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor'
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/gradle.yml

@@ -9,6 +9,7 @@ jobs:
   gradle:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         java-version:
           - 17

.github/workflows/mvn.yml

@@ -9,6 +9,7 @@ jobs:
   mvn:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         java-version:
           - 17

.gitignore

@@ -7,6 +7,7 @@
 .idea/
 .env
 artifacts/
+bin/
 src/main/webapp/WEB-INF/classes/
 src/main/webapp/WEB-INF/lib/
 *.iml

README.md

@@ -1,7 +1,7 @@
 # Bolt for Java Custom Step Template
 
 This is a Bolt for Java template app used to build custom steps for use in
-[Workflow Builder](https://api.slack.com/start#workflow-builder).
+[Workflow Builder](https://docs.slack.dev/workflows/workflow-builder/).
 
 ## Setup
 
@@ -22,9 +22,9 @@ tooling, and resources created to help developers build and grow.
 
 1. Open [https://api.slack.com/apps/new](https://api.slack.com/apps/new) and choose "From an app manifest"
 2. Choose the workspace you want to install the application to
-3. Copy the contents of [manifest.json](./manifest.json) into the text box that says `*Paste your manifest code here*` (within the JSON tab) and click *Next*
-4. Review the configuration and click *Create*
-5. Click *Install to Workspace* and *Allow* on the screen that follows. You'll then be redirected to the App Configuration dashboard.
+3. Copy the contents of [manifest.json](./manifest.json) into the text box that says `*Paste your manifest code here*` (within the JSON tab) and click _Next_
+4. Review the configuration and click _Create_
+5. Click _Install to Workspace_ and _Allow_ on the screen that follows. You'll then be redirected to the App Configuration dashboard.
 
 #### Environment Variables
 
@@ -43,16 +43,17 @@ export SLACK_APP_TOKEN=<your-app-token>
 
 ```zsh
 # Clone this project onto your machine
-git clone https://github.com/WilliamBergamin/bolt-java-custom-step-template.git
+git clone https://github.com/slack-samples/bolt-java-custom-step-template.git
 
 # Change into this project directory
-cd bolt-java-template
+cd bolt-java-custom-step-template
 ```
 
 #### Maven: Run
 
 Ensure [maven](https://maven.apache.org/index.html) is installed on your local environment.
-* We recommend using [brew to install Maven on macOS](https://formulae.brew.sh/formula/maven)
+
+- We recommend using [brew to install Maven on macOS](https://formulae.brew.sh/formula/maven)
 
 ```zsh
 # Install the dependencies and compile
@@ -68,14 +69,15 @@ mvn clean test
 mvn clean compile exec:java -Dexec.mainClass="Main"
 ```
 
-**NOTE**: If you chose to use Maven as your build tool you can remove the `builde.gradle` file from this project.
+**NOTE**: If you chose to use Maven as your build tool you can remove the `build.gradle` file from this project.
 
-------
+---
 
 #### Gradle: Run
 
 Ensure [gradle](https://gradle.org/) is installed on your local environment.
-* We recommend using [brew to install Gradle on macOS](https://formulae.brew.sh/formula/gradle)
+
+- We recommend using [brew to install Gradle on macOS](https://formulae.brew.sh/formula/gradle)
 
 ```zsh
 # Run tests
@@ -93,7 +95,7 @@ gradle run
 ## Using Steps in Workflow Builder
 
 With your server running, the `Sample step` is now ready for use in
-[Workflow Builder](https://api.slack.com/start#workflow-builder)! Add it as a
+[Workflow Builder](https://docs.slack.dev/workflows/workflow-builder/)! Add it as a
 custom step in a new or existing workflow, then run the workflow while your app
 is running.
 

build.gradle

@@ -4,16 +4,16 @@ plugins {
 }
 
 java {
-	sourceCompatibility = JavaVersion.VERSION_11
-	targetCompatibility = JavaVersion.VERSION_11
+	sourceCompatibility = JavaVersion.VERSION_17
+	targetCompatibility = JavaVersion.VERSION_17
 }
 
 repositories {
 	mavenCentral()
 }
 
 dependencies {
-	implementation("ch.qos.logback:logback-classic:1.5.21")
+	implementation("ch.qos.logback:logback-classic:1.5.22")
 	// ***** SOCKET MODE DEPENDENCIES ***** -->
 	implementation("com.slack.api:bolt:1.46.0")
 	implementation("com.slack.api:bolt-socket-mode:1.46.0")
@@ -24,7 +24,7 @@ dependencies {
 	// ***** TEST DEPENDENCIES *****
 	testImplementation('org.junit.jupiter:junit-jupiter-api:6.0.1')
 	testRuntimeOnly('org.junit.jupiter:junit-jupiter-engine:6.0.1')
-	testImplementation('org.mockito:mockito-core:5.20.0')
+	testImplementation('org.mockito:mockito-core:5.21.0')
 }
 
 application {
@@ -43,7 +43,7 @@ spotless {
 	format 'misc', {
 		target '*.gradle', '.gitignore'
 		trimTrailingWhitespace()
-		indentWithTabs(4)
+		leadingSpacesToTabs(4)
 		endWithNewline()
 	}
 	java {

pom.xml

@@ -66,7 +66,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.5.21</version>
+            <version>1.5.22</version>
         </dependency>
         <!-- ***** SOCKET MODE DEPENDENCIES ***** -->
         <dependency>

src/test/java/listeners/actions/CustomStepButtonActionListenerTest.java

@@ -0,0 +1,32 @@
+package listeners.actions;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.mockito.Mockito.*;
+
+import com.slack.api.bolt.App;
+import com.slack.api.bolt.context.builtin.ActionContext;
+import com.slack.api.bolt.request.builtin.BlockActionRequest;
+import com.slack.api.methods.SlackApiException;
+import java.io.IOException;
+import org.junit.jupiter.api.Test;
+
+public class CustomStepButtonActionListenerTest {
+
+    @Test
+    public void testApply() throws IOException, SlackApiException {
+        // Given
+        var app = new App();
+        var reqMock = mock(BlockActionRequest.class);
+        var ctxMock = mock(ActionContext.class);
+
+        when(ctxMock.ack()).thenReturn(mock(com.slack.api.bolt.response.Response.class));
+
+        // When
+        var customStepButtonActionListener = new CustomStepButtonActionListener(app);
+        var res = customStepButtonActionListener.apply(reqMock, ctxMock);
+
+        // Then
+        verify(ctxMock).ack();
+        assertNotNull(res);
+    }
+}

src/test/java/listeners/functions/SampleStepListenerTest.java

@@ -0,0 +1,34 @@
+package listeners.functions;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.*;
+
+import com.slack.api.app_backend.events.payload.EventsApiPayload;
+import com.slack.api.bolt.App;
+import com.slack.api.bolt.context.builtin.EventContext;
+import com.slack.api.bolt.response.Response;
+import com.slack.api.model.event.FunctionExecutedEvent;
+import org.junit.jupiter.api.Test;
+
+public class SampleStepListenerTest {
+
+    @Test
+    public void testApply() {
+        // Given
+        var plMock = (EventsApiPayload<FunctionExecutedEvent>) mock(EventsApiPayload.class);
+        var ctxMock = mock(EventContext.class);
+
+        var responseMock = mock(Response.class);
+        when(responseMock.getStatusCode()).thenReturn(200);
+        when(ctxMock.ack()).thenReturn(responseMock);
+
+        // When
+        var app = new App();
+        var sampleStepListener = new SampleStepListener(app);
+        var res = sampleStepListener.apply(plMock, ctxMock);
+
+        // Then
+        verify(ctxMock).ack();
+        assertEquals(res.getStatusCode(), 200);
+    }
+}