fixed init container / added storing artifacts in github releases / other minor fixes

Author: kilmajster

.run/debug-in-docker.run.xml renamed to .github/debug-in-docker.run.xml

@@ -1,6 +1,6 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="debug-in-docker" type="Remote">
-    <module name="keycloak-user-attribute-authenticator" />
+    <module name="keycloak-username-password-attribute-authenticator" />
     <option name="USE_SOCKET_TRANSPORT" value="true" />
     <option name="SERVER_MODE" value="false" />
     <option name="SHMEM_ADDRESS" />

.github/workflows/automation_tests.yml

@@ -11,14 +11,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up JDK 11
       uses: actions/setup-java@v2
       with:
         java-version: '11'
         distribution: 'adopt'
+
     - name: Build authenticator jar file
       run: mvn -B -ntp package
-    - name: Build test Docker container
-      run: docker build -f src/main/docker/dev.Dockerfile -t kilmajster/keycloak-with-authenticator:test .
+
+    - name: Build test docker container
+      run: docker-compose build
+
     - name: Run Selenide tests
       run: mvn -B -ntp test -P automation-tests -D headless=true

.github/workflows/publish.yml

@@ -9,6 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+
       - name: Set up Maven Central Repository
         uses: actions/setup-java@v2
         with:
@@ -17,16 +18,21 @@ jobs:
           server-id: ossrh
           server-username: MAVEN_USERNAME
           server-password: MAVEN_PASSWORD
-      - name: Build project
+
+      - name: Build a project
         run: mvn -B -ntp package
+
       - name: Get the tag name
         run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+
       - name: Set version from git tag
         run: mvn -B -ntp versions:set -DgenerateBackupPoms=false -DnewVersion="$TAG"
-      - name: Import gpg secret key
+
+      - name: Import GPG key
         run: |
           cat <(echo -e "${{ secrets.OSSRH_GPG_SECRET_KEY }}") | gpg --batch --import
           gpg --list-secret-keys --keyid-format LONG
+
       - name: Publish maven package
         run: |
           mvn \
@@ -38,20 +44,33 @@ jobs:
         env:
           MAVEN_USERNAME: kilmajster
           MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+
+      - name: Add jar to github release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: target/keycloak-username-password-attribute-authenticator-${{ github.ref }}.jar
+          asset_name: keycloak-username-password-attribute-authenticator-${{ github.ref }}.jar
+          tag: ${{ github.ref }}
+
       - name: Build docker init container
         run: |
           echo "Building docker image = kilmajster/keycloak-username-password-attribute-authenticator:$TAG" && \
           docker build \
+          --build-arg VERSION="$TAG" \
           -f src/main/docker/initContainer.Dockerfile \
           -t kilmajster/keycloak-username-password-attribute-authenticator:"$TAG" \
           -t kilmajster/keycloak-username-password-attribute-authenticator:latest \
           .
+
       - name: Log into Docker Hub
         uses: docker/login-action@v1
         with:
           username: kilmajster
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
-      - name: Push tagged image
+
+      - name: Push tagged docker image
         run: docker push kilmajster/keycloak-username-password-attribute-authenticator:"$TAG"
-      - name: Push latest image
+
+      - name: Push latest docker image
         run: docker push kilmajster/keycloak-username-password-attribute-authenticator:latest

.gitignore

@@ -24,4 +24,4 @@ hs_err_pid*
 /build/
 /keycloak-username-password-attribute-authenticator.iml
 /.idea/
-/target/
+/target/

README.md

@@ -8,13 +8,17 @@
 ## Description
 Keycloak default login form with user attribute validation.
 
-## Using
+## How 2 use
 ### using jar
 ### using docker init container
+```
+kilmajster/keycloak-username-password-attribute-authenticator:latest
+```
+#### example helm chart snippet
 
 ## Configuration
 ### Authenticator config
-#### config via Keycloak UI
+#### config via Keycloak UI / API
  - login_form_user_attribute
  - login_form_generate_label
  - login_form_attribute_label
@@ -28,16 +32,31 @@ Keycloak default login form with user attribute validation.
 #### Using bundled default keycloak theme
 #### Extending own theme
 
-## docker
-### example in docker-compose
+-------------------------------------
+### Development
+#### build the project
 ```shell
-$ docker-compose up --build --force-recreate
+$ mvn package
 ```
- http://localhost:8081/auth/realms/dev-realm/account
-
+#### run with docker-compose
+```shell
+$ docker-compose up --build
+```
+http://localhost:8081/auth/realms/dev-realm/account
+##### debug in docker with IntelliJ
+`.github/debug-in-docker.run.xml`
 
-### init container
+#### automation tests
+##### build test docker image
+```shell
+$ docker-compose build
 ```
-kilmajster/keycloak-username-password-attribute-authenticator:latest
+##### running tests with chrome
+```shell
+$ mvn test -P automation-tests
+```
+##### running tests in docker
+```shell
+$ mvn test -P automation-tests -D headless=true
 ```
 

docker-compose.yml

@@ -11,7 +11,7 @@ services:
       - 8081:8080
       - 8787:8787
     volumes:
-      - ./src/main/resources/dev-realm.json:/tmp/dev-realm.json
+      - ./src/test/resources/dev-realm.json:/tmp/dev-realm.json
     environment:
       DEBUG: 'true'
       DEBUG_PORT: '*:8787'

src/main/docker/dev.Dockerfile

@@ -1,3 +1,3 @@
 FROM quay.io/keycloak/keycloak:latest
 
-ADD target/keycloak-username-password-attribute-authenticator-*.jar /opt/jboss/keycloak/standalone/deployments
+ADD target/keycloak-username-password-attribute-authenticator-SNAPSHOT.jar /opt/jboss/keycloak/standalone/deployments

src/main/docker/initContainer.Dockerfile

@@ -1,3 +1,5 @@
 FROM busybox
 
-COPY target/keycloak-username-password-attribute-authenticator-*.jar /opt/jboss/keycloak/standalone/deployments/
+ARG VERSION
+
+COPY target/keycloak-username-password-attribute-authenticator-${VERSION}.jar /opt/jboss/keycloak/standalone/deployments/

src/main/resources/theme/base-with-attribute/login/login.ftl

@@ -41,10 +41,11 @@
                         <#else>
                             ${msg("login_form_attribute_label_default")}
                         </#if>
-                 </label>
+                    </label>
 
-                    <input tabindex="3" id="login_form_user_attribute" class="${properties.kcInputClass!}" name="login_form_user_attribute" type="text" autocomplete="off"
-                           aria-invalid="<#if messagesPerField.existsError('username','password')>true</#if>"
+                    <input tabindex="3" id="login_form_user_attribute" class="${properties.kcInputClass!}"
+                           name="login_form_user_attribute" type="text" autocomplete="off"
+                           aria-invalid="<#if messagesPerField.existsError('login_form_user_attribute')>true</#if>"
                     />
                 </div>
                 <!-- keycloak-user-attribute-authenticator custom code block end -->

src/test/java/io.github.kilmajster.keycloak/UsernamePasswordAttributeFormAT.java

@@ -21,9 +21,9 @@ public class UsernamePasswordAttributeFormAT extends BaseKeycloakInDockerAT {
 
     @Test
     public void shouldLogIntoAccountConsole() {
-        final String url = getKeycloakBaseUrl(keycloak.getFirstMappedPort());
+        final String keycloakBaseUrl = getKeycloakBaseUrl(keycloak);
 
-        go_to_keycloak_account_page(url);
+        go_to_keycloak_account_page(keycloakBaseUrl);
         click_sign_in_button();
         verify_login_form_is_displayed_with_user_attribute_label("Test attr");
         log_into_account_console();