Merge pull request #2 from emmartins/ejb-security-context-propagation…

…-enhancements

Squash me

.github/workflows/quickstart_ci.yml

@@ -89,6 +89,10 @@ jobs:
           cd ${{ inputs.QUICKSTART_PATH }}
           echo "Building provisioned server..."
           mvn -U -B -fae clean package -Pprovisioned-server
+          echo "Add quickstartUser..."
+          target/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest,user,JBossAdmin,Users'
+          echo "Add quickstartAdmin..."
+          target/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' -g 'guest,user,admin'
           echo "Starting provisioned server..."
           mvn -U -B -fae wildfly:start -DjbossHome=target/server -Dstartup-timeout=120
           echo "Testing provisioned server..."

.github/workflows/quickstart_ejb-security-context-propagation_ci.yml

@@ -4,8 +4,8 @@ on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
-      - ejb-security-context-propagation/**'
-      - .github/workflows/quickstart_ci.yml
+      - 'ejb-security-context-propagation/**'
+      - '.github/workflows/quickstart_ci.yml'
 
 jobs:
   call-quickstart_ci:

ejb-security-context-propagation/README.adoc

@@ -195,20 +195,12 @@ Note that the `http-connector` in the `remoting` subsystem uses this `applicatio
 // Build and Deploy the Quickstart JAR
 include::../shared-doc/build-and-deploy-the-quickstart.adoc[leveloffset=+1]
 
-== Run the Client
-
-Before you run the client, make sure you have already successfully deployed the EJBs to the server in the previous step and that your terminal is still in the same folder.
-
-Type this command to execute the client:
-
-[source,options="nowrap"]
-----
-$ mvn exec:exec
-----
+// Server Distribution Testing
+include::../shared-doc/run-integration-tests-with-server-distribution.adoc[leveloffset=+2]
 
 == Investigate the Console Output
 
-When you run the `mvn exec:exec` command, you see the following output. Note there may be other log messages interspersed between these.
+When you run the integration tests, you see the following output. Note there may be other log messages interspersed between these.
 
 [source,options="nowrap"]
 ----
@@ -307,34 +299,10 @@ The batch executed successfully
 
 // Restore the {productName} Standalone Server Configuration Manually
 include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2]
-// Run the Quickstart in Red Hat CodeReady Studio or Eclipse
-include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1]
-
-// Additional Red Hat CodeReady Studio instructions
-This quickstart requires additional configuration and deploys and runs differently in {JBDSProductName} than the other quickstarts.
-
-. Make sure you xref:add_the_application_users[Add the Application Users] as described above.
-. Follow the steps above to xref:configure_the_server[Configure the Server]. Stop the server at the end of that step.
-. To deploy the application to the {productName} server, right-click on the *{artifactId}* project and choose *Run As* -> *Run on Server*.
-. To access the application, right-click on the *{artifactId}* project and choose *Run As* -> *Java Application*.
-. Choose *RemoteClient - org.jboss.as.quickstarts.ejb_security_context_propagation* and click *OK*.
-. Review the output in the console window.
-. To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* -> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*.
-. Make sure you xref:restore_the_server_configuration[restore the server configuration] when you have completed testing this quickstart.
-
-// Debug the Application
-include::../shared-doc/debug-the-application.adoc[leveloffset=+1]
 // Build and run sections for other environments/builds
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 
-//*************************************************
-// Product Release content only
-//*************************************************
-ifdef::ProductRelease[]
-
 // Quickstart not compatible with OpenShift
-include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1]
-
-endif::[]
+include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1]

ejb-security-context-propagation/pom.xml

@@ -174,29 +174,6 @@
                         <generateClient>true</generateClient>
                     </configuration>
                 </plugin>
-                <!-- Add the Maven exec plug-in to allow us to run a Java program via Maven -->
-                <plugin>
-                    <groupId>org.codehaus.mojo</groupId>
-                    <artifactId>exec-maven-plugin</artifactId>
-                    <configuration>
-                        <executable>java</executable>
-                        <workingDirectory>${project.build.directory}/exec-working-directory</workingDirectory>
-                        <arguments>
-                            <!-- automatically creates the classpath using all project dependencies,
-                                        also adding the project build directory -->
-                            <argument>-classpath</argument>
-                            <classpath></classpath>
-                            <argument>org.jboss.as.quickstarts.ejb_security_context_propagation.RemoteClient</argument>
-                        </arguments>
-                    </configuration>
-                    <executions>
-                        <execution>
-                            <goals>
-                                <goal>exec</goal>
-                            </goals>
-                        </execution>
-                    </executions>
-                </plugin>
                 <plugin>
                   <groupId>org.wildfly.plugins</groupId>
                   <artifactId>wildfly-maven-plugin</artifactId>
@@ -224,6 +201,16 @@
                                 <layer>cloud-server</layer>
                                 <layer>ejb</layer>
                             </layers>
+                            <!-- use cli script(s) to configure the server -->
+                            <packaging-scripts>
+                                <packaging-script>
+                                    <scripts>
+                                        <script>${basedir}/configure-elytron.cli</script>
+                                    </scripts>
+                                    <!-- Expressions resolved during server execution -->
+                                    <resolve-expressions>false</resolve-expressions>
+                                </packaging-script>
+                            </packaging-scripts>
                             <!-- deploys the quickstart on root web context -->
                             <name>ROOT.war</name>
                         </configuration>

ejb-security-context-propagation/src/main/java/org/jboss/as/quickstarts/ejb_security_context_propagation/EJBServlet.java

@@ -25,22 +25,22 @@
 import jakarta.servlet.http.HttpServletResponse;
 /**
  * <p>
- * A simple servlet taking advantage of features added in 3.0.
+ * A simple servlet which indicates successful deployment of the quickstart.
  * </p>
  *
  * <p>
- * The servlet is registered and mapped to /EJBServlet using the {@linkplain WebServlet
+ * The servlet is registered and mapped to /ejb-security-context-propagation using the {@linkplain WebServlet
  * @HttpServlet}.
  * </p>
  *
  * @author Prarthona Paul
  *
  */
 
-@WebServlet("ejb-security-context-propagation")
+@WebServlet("/ejb-security-context-propagation")
 public class EJBServlet extends HttpServlet {
 
-    static String PAGE_HEADER = "<html><head><title>helloworld</title></head><body>";
+    static String PAGE_HEADER = "<html><head><title>ejb-security-context-propagation</title></head><body>";
 
     static String PAGE_FOOTER = "</body></html>";
 
@@ -49,7 +49,7 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IO
         resp.setContentType("text/html");
         PrintWriter writer = resp.getWriter();
         writer.println(PAGE_HEADER);
-        writer.println("<h1> ejb-security-context-propagation quickstart deployed successfully. You can find the available operations in the included README file. </h1>");
+        writer.println("ejb-security-context-propagation quickstart deployed successfully. You can find the available operations in the included README file.");
         writer.println(PAGE_FOOTER);
         writer.close();
     }

ejb-security-context-propagation/src/main/java/org/jboss/as/quickstarts/ejb_security_context_propagation/IntermediateEJB.java

@@ -36,7 +36,7 @@
 @PermitAll
 public class IntermediateEJB implements IntermediateEJBRemote {
 
-    @EJB(lookup="ejb:/ejb-security-context-propagation/SecuredEJB!org.jboss.as.quickstarts.ejb_security_context_propagation.SecuredEJBRemote")
+    @EJB
     private SecuredEJBRemote remote;
 
     @Resource

ejb-security-context-propagation/src/main/java/org/jboss/as/quickstarts/ejb_security_context_propagation/RemoteClient.java → ejb-security-context-propagation/src/test/java/org/jboss/as/quickstarts/ejb_security_context_propagation/SecurityContextPropagationIT.java

@@ -1,13 +1,12 @@
 /*
- * JBoss, Home of Professional Open Source
- * Copyright 2017, Red Hat, Inc. and/or its affiliates, and individual
- * contributors by the @authors tag. See the copyright.txt in the
- * distribution for a full listing of individual contributors.
+ * Copyright 2023 JBoss by Red Hat.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -16,43 +15,47 @@
  */
 package org.jboss.as.quickstarts.ejb_security_context_propagation;
 
-import java.util.Hashtable;
-
-import javax.naming.Context;
-import javax.naming.InitialContext;
-
+import org.junit.Test;
 import org.wildfly.security.auth.client.AuthenticationConfiguration;
 import org.wildfly.security.auth.client.AuthenticationContext;
 import org.wildfly.security.auth.client.MatchRule;
 import org.wildfly.security.sasl.SaslMechanismSelector;
 
+import javax.naming.Context;
+import javax.naming.InitialContext;
+import javax.naming.NamingException;
+import java.util.Hashtable;
+
 /**
- * The remote client responsible for making invoking the intermediate bean to demonstrate security context propagation
- * in EJB to remote EJB calls.
- *
+ * The functional integration testing.
+ * @author emartins
  * @author <a href="mailto:[email protected]">Stefan Guilhen</a>
+ *
  */
-public class RemoteClient {
+public class SecurityContextPropagationIT {
 
-    public static void main(String[] args) throws Exception {
+    @Test
+    public void testSecurityContextPropagation() throws NamingException {
+        // we assume standard dist, where EJBs are at ejb:/ejb-security-context-propagation/, if no SERVER_HOST or server.host in env/system props
+        final boolean standardDist = System.getenv("SERVER_HOST") == null && System.getProperty("server.host") == null;
+        System.out.println("standardDist: "+standardDist);
         // invoke the intermediate bean using the identity configured in wildfly-config.xml
-        invokeIntermediateBean();
-
+        invokeIntermediateBean(standardDist);
         // now lets programmatically setup an authentication context to switch users before invoking the intermediate bean
         AuthenticationConfiguration superUser = AuthenticationConfiguration.empty().setSaslMechanismSelector(SaslMechanismSelector.NONE.addMechanism("PLAIN")).
                 useName("quickstartAdmin").usePassword("adminPwd1!");
         final AuthenticationContext authCtx = AuthenticationContext.empty().with(MatchRule.ALL, superUser);
         AuthenticationContext.getContextManager().setThreadDefault(authCtx);
-        invokeIntermediateBean();
+        invokeIntermediateBean(standardDist);
     }
 
-    private static void invokeIntermediateBean() throws Exception {
+    private static void invokeIntermediateBean(boolean standardDist) throws NamingException {
         final Hashtable<String, String> jndiProperties = new Hashtable<>();
         jndiProperties.put(Context.INITIAL_CONTEXT_FACTORY, "org.wildfly.naming.client.WildFlyInitialContextFactory");
         jndiProperties.put(Context.PROVIDER_URL, "remote+http://localhost:8080");
         final Context context = new InitialContext(jndiProperties);
 
-        IntermediateEJBRemote intermediate = (IntermediateEJBRemote) context.lookup("ejb:/ejb-security-context-propagation/IntermediateEJB!"
+        IntermediateEJBRemote intermediate = (IntermediateEJBRemote) context.lookup("ejb:/"+(standardDist?"ejb-security-context-propagation":"ROOT")+"/IntermediateEJB!"
                 + IntermediateEJBRemote.class.getName());
         System.out.println("\n\n* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\n");
         System.out.println(intermediate.makeRemoteCalls());

shared-doc/add-application-and-management-users.adoc

@@ -27,6 +27,11 @@ ifndef::admin-user-groups[]
 :admin-group-list:
 :admin-group-command:
 endif::admin-user-groups[]
+
+// attr which other sections may check (ifdef) to know if users needs to be added
+:addQuickstartUser: true
+:addQuickstartAdmin: true
+
 This quickstart uses secured management interfaces and requires that you create the following application user to access the running application.
 
 [cols="20%,20%,20%,40%",options="headers"]

shared-doc/add-application-user.adoc

@@ -17,6 +17,9 @@ ifndef::app-user-groups[]
 :app-group-command:
 endif::app-user-groups[]
 
+// attr which other sections may check (ifdef) to know if users needs to be added
+:addQuickstartUser: true
+
 This quickstart uses secured application interfaces and requires that you create the following application user to access the running application.
 
 [cols="20%,20%,20%,40%",options="headers"]

shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc

@@ -23,6 +23,30 @@ $ mvn {mavenServerProvisioningCommand} -Pprovisioned-server
 
 The provisioned {productName} server, with the quickstart deployed, can then be found in the `target/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started.
 
+ifdef::addQuickstartUser[]
+The quickstart user should be added before running the provisioned server:
+[source,subs="+quotes,attributes+",options="nowrap"]
+----
+$ target/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command}
+----
+[NOTE]
+====
+For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script.
+====
+endif::[]
+
+ifdef::addQuickstartAdmin[]
+The quickstart admin should be added before running the provisioned server:
+[source,subs="+quotes,attributes+",options="nowrap"]
+----
+$ target/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command}
+----
+[NOTE]
+====
+For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script.
+====
+endif::[]
+
 The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`:
 
 [source,xml,subs="attributes+"]

shared-doc/run-integration-tests-with-provisioned-server.adoc

@@ -14,7 +14,28 @@ Follow these steps to run the integration tests.
 $ mvn clean package -Pprovisioned-server
 ----
 
-. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommend for testing due to simpler automation. The path to the provisioned server should be specified using the `server.host` system property.
+ifdef::addQuickstartUser[]
+Add the quickstart user:
+[source,subs="+quotes,attributes+",options="nowrap"]
+----
+$ target/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command}
+----
+endif::[]
+
+ifdef::addQuickstartAdmin[]
+Add the quickstart admin:
+[source,subs="+quotes,attributes+",options="nowrap"]
+----
+$ target/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command}
+----
+[NOTE]
+====
+For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script.
+====
+endif::[]
+
+
+. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. The path to the provisioned server should be specified using the `server.host` system property.
 +
 [source,subs="attributes+",options="nowrap"]
 ----