fix(plc4j): add fireDiscoverEvent (replacing awaitDiscoverComplete) a…

…nd moving awaitDiscoverComplete to it's true prupose

Rational: logic is wrong here. The awaits primary purpose it for the Driver test runner to not block. So the action should be done in any case just the waiting should be controlled. As you can see here the event in only fired if the variable is through hence affecting logic. So there should be a new variable called fire discover and the keep the current one to wait for something

plc4j/drivers/eip/src/main/java/org/apache/plc4x/java/eip/base/EIPDriver.java

@@ -165,6 +165,12 @@ public PlcConnection getConnection(String connectionString) throws PlcConnection
         // Give drivers the option to customize the channel.
         initializePipeline(channelFactory);
 
+        // Make the "fire discover event" overridable via system property.
+        boolean fireDiscoverEvent = fireDiscoverEvent();
+        if(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT) != null) {
+            fireDiscoverEvent = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT));
+        }
+
         // Make the "await setup complete" overridable via system property.
         boolean awaitSetupComplete = awaitSetupComplete();
         if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE) != null) {
@@ -189,6 +195,7 @@ public PlcConnection getConnection(String connectionString) throws PlcConnection
             getValueHandler(),
             configuration,
             channelFactory,
+            fireDiscoverEvent,
             awaitSetupComplete,
             awaitDisconnectComplete,
             awaitDiscoverComplete,

plc4j/drivers/opcua/src/main/java/org/apache/plc4x/java/opcua/OpcuaPlcDriver.java

@@ -75,7 +75,7 @@ protected String getDefaultTransport() {
     }
 
     @Override
-    protected boolean awaitDiscoverComplete() {
+    protected boolean fireDiscoverEvent() {
         return isEncrypted;
     }
 
@@ -186,6 +186,12 @@ public PlcConnection getConnection(String connectionString) throws PlcConnection
         // Give drivers the option to customize the channel.
         initializePipeline(channelFactory);
 
+        // Make the "fire discover event" overridable via system property.
+        boolean fireDiscoverEvent = fireDiscoverEvent();
+        if(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT) != null) {
+            fireDiscoverEvent = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT));
+        }
+
         // Make the "await setup complete" overridable via system property.
         boolean awaitSetupComplete = awaitSetupComplete();
         if (System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE) != null) {
@@ -220,6 +226,7 @@ public PlcConnection getConnection(String connectionString) throws PlcConnection
             getValueHandler(),
             configuration,
             channelFactory,
+            fireDiscoverEvent,
             awaitSetupComplete,
             awaitDisconnectComplete,
             awaitDiscoverComplete,

plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/S7HGeneratedDriverBase.java

@@ -124,6 +124,12 @@ public PlcConnection getConnection(String connectionString) throws PlcConnection
             }
         }
 
+        // Make the "fire discover event" overridable via system property.
+        boolean fireDiscoverEvent = fireDiscoverEvent();
+        if(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT) != null) {
+            fireDiscoverEvent = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT));
+        }
+
         // Make the "await setup complete" overridable via system property.
         boolean awaitSetupComplete = awaitSetupComplete();
         if (System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE) != null) {
@@ -149,6 +155,7 @@ public PlcConnection getConnection(String connectionString) throws PlcConnection
             configuration,
             channelFactory,
             secondaryChannelFactory,
+            fireDiscoverEvent,
             awaitSetupComplete,
             awaitDisconnectComplete,
             awaitDiscoverComplete,

plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/connection/S7HDefaultNettyPlcConnection.java

@@ -76,6 +76,7 @@ public S7HDefaultNettyPlcConnection(boolean canRead,
                                         Configuration configuration,
                                         ChannelFactory channelFactory,
                                         ChannelFactory secondaryChannelFactory,
+                                        boolean fireDiscoverEvent,
                                         boolean awaitSessionSetupComplete,
                                         boolean awaitSessionDisconnectComplete,
                                         boolean awaitSessionDiscoverComplete,
@@ -90,6 +91,7 @@ public S7HDefaultNettyPlcConnection(boolean canRead,
             valueHandler,
             configuration,
             channelFactory,
+            fireDiscoverEvent,
             awaitSessionSetupComplete,
             awaitSessionDisconnectComplete,
             awaitSessionDiscoverComplete,

plc4j/spi/src/main/java/org/apache/plc4x/java/spi/connection/DefaultNettyPlcConnection.java

@@ -54,7 +54,7 @@ public class DefaultNettyPlcConnection extends AbstractPlcConnection implements
 
     protected final Configuration configuration;
     protected final ChannelFactory channelFactory;
-
+    protected final boolean fireDiscoverEvent;
     protected final boolean awaitSessionSetupComplete;
     protected final boolean awaitSessionDisconnectComplete;
     protected final boolean awaitSessionDiscoverComplete;
@@ -73,6 +73,7 @@ public DefaultNettyPlcConnection(boolean canRead,
                                      PlcValueHandler valueHandler,
                                      Configuration configuration,
                                      ChannelFactory channelFactory,
+                                     boolean fireDiscoverEvent,
                                      boolean awaitSessionSetupComplete,
                                      boolean awaitSessionDisconnectComplete,
                                      boolean awaitSessionDiscoverComplete,
@@ -82,6 +83,7 @@ public DefaultNettyPlcConnection(boolean canRead,
         super(canRead, canWrite, canSubscribe, canBrowse, tagHandler, valueHandler, optimizer, authentication);
         this.configuration = configuration;
         this.channelFactory = channelFactory;
+        this.fireDiscoverEvent = fireDiscoverEvent;
         this.awaitSessionSetupComplete = awaitSessionSetupComplete;
         //Used to signal that a disconnect has completed while closing a connection.
         this.awaitSessionDisconnectComplete = awaitSessionDisconnectComplete;
@@ -109,7 +111,7 @@ public void connect() throws PlcConnectionException {
             ConfigurationFactory.configure(configuration, channelFactory);
 
             // Have the channel factory create a new channel instance.
-            if (awaitSessionDiscoverComplete) {
+            if (fireDiscoverEvent) {
                 channel = channelFactory.createChannel(getChannelHandler(sessionSetupCompleteFuture, sessionDisconnectCompleteFuture, sessionDiscoveredCompleteFuture));
                 channel.closeFuture().addListener(future -> {
                     if (!sessionDiscoveredCompleteFuture.isDone()) {
@@ -123,7 +125,8 @@ public void connect() throws PlcConnectionException {
                     }
                 });
                 channel.pipeline().fireUserEventTriggered(new DiscoverEvent());
-
+            }
+            if (awaitSessionDiscoverComplete) {
                 // Wait till the connection is established.
                 sessionDiscoveredCompleteFuture.get();
             }

plc4j/spi/src/main/java/org/apache/plc4x/java/spi/connection/GeneratedDriverBase.java

@@ -37,6 +37,7 @@
 
 public abstract class GeneratedDriverBase<BASE_PACKET extends Message> implements PlcDriver {
 
+    public static final String PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT = "PLC4X_FORCE_FIRE_DISCOVER_EVENT";
     public static final String PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE = "PLC4X_FORCE_AWAIT_SETUP_COMPLETE";
     public static final String PROPERTY_PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE = "PLC4X_FORCE_AWAIT_DISCONNECT_COMPLETE";
     public static final String PROPERTY_PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE = "PLC4X_FORCE_AWAIT_DISCOVER_COMPLETE";
@@ -62,6 +63,10 @@ protected boolean canBrowse() {
         return false;
     }
 
+    protected boolean fireDiscoverEvent() {
+        return true;
+    }
+
     protected boolean awaitSetupComplete() {
         return true;
     }
@@ -154,6 +159,12 @@ public PlcConnection getConnection(String connectionString, PlcAuthentication au
         // Give drivers the option to customize the channel.
         initializePipeline(channelFactory);
 
+        // Make the "fire discover event" overridable via system property.
+        boolean fireDiscoverEvent = fireDiscoverEvent();
+        if(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT) != null) {
+            fireDiscoverEvent = Boolean.parseBoolean(System.getProperty(PROPERTY_PLC4X_FORCE_FIRE_DISCOVER_EVENT));
+        }
+
         // Make the "await setup complete" overridable via system property.
         boolean awaitSetupComplete = awaitSetupComplete();
         if(System.getProperty(PROPERTY_PLC4X_FORCE_AWAIT_SETUP_COMPLETE) != null) {
@@ -178,6 +189,7 @@ public PlcConnection getConnection(String connectionString, PlcAuthentication au
             getValueHandler(),
             configuration,
             channelFactory,
+            fireDiscoverEvent,
             awaitSetupComplete,
             awaitDisconnectComplete,
             awaitDiscoverComplete,