Review update

Author: lordgamez

behave_framework/src/minifi_test_framework/containers/minifi_container.py

@@ -97,26 +97,6 @@ def set_log_property(self, key: str, value: str):
     def enable_openssl_fips_mode(self):
         self.properties["nifi.openssl.fips.support.enable"] = "true"
 
-    def enable_c2(self):
-        self.properties["nifi.c2.enable"] = "true"
-        self.properties["nifi.c2.rest.url"] = f"http://minifi-c2-server-{self.scenario_id}:10090/c2/config/heartbeat"
-        self.properties["nifi.c2.rest.url.ack"] = f"http://minifi-c2-server-{self.scenario_id}:10090/c2/config/acknowledge"
-        self.properties["nifi.c2.flow.base.url"] = f"http://minifi-c2-server-{self.scenario_id}:10090/c2/config/"
-        self.properties["nifi.c2.root.classes"] = "DeviceInfoNode,AgentInformation,FlowInformation,AssetInformation"
-        self.properties["nifi.c2.full.heartbeat"] = "false"
-        self.properties["nifi.c2.agent.class"] = "minifi-test-class"
-        self.properties["nifi.c2.agent.identifier"] = "minifi-test-id"
-
-    def enable_c2_with_ssl(self):
-        self.properties["nifi.c2.enable"] = "true"
-        self.properties["nifi.c2.rest.url"] = f"https://minifi-c2-server-{self.scenario_id}:10090/c2/config/heartbeat"
-        self.properties["nifi.c2.rest.url.ack"] = f"https://minifi-c2-server-{self.scenario_id}:10090/c2/config/acknowledge"
-        self.properties["nifi.c2.flow.base.url"] = f"https://minifi-c2-server-{self.scenario_id}:10090/c2/config/"
-        self.properties["nifi.c2.root.classes"] = "DeviceInfoNode,AgentInformation,FlowInformation,AssetInformation"
-        self.properties["nifi.c2.full.heartbeat"] = "false"
-        self.properties["nifi.c2.agent.class"] = "minifi-test-class"
-        self.properties["nifi.c2.agent.identifier"] = "minifi-test-id"
-
     def fetch_flow_config_from_flow_url(self):
         self.properties["nifi.c2.flow.url"] = f"http://minifi-c2-server-{self.scenario_id}:10090/c2/config?class=minifi-test-class"
 

behave_framework/src/minifi_test_framework/steps/checking_steps.py

@@ -249,11 +249,3 @@ def step_impl(context: MinifiTestContext, container_name: str, directory: str, s
 def step_impl(context: MinifiTestContext, directory: str, size: str, duration: str):
     context.execute_steps(
         f'Then in the "{DEFAULT_MINIFI_CONTAINER_NAME}" container at least one file with minimum size of "{size}" is placed in the "{directory}" directory in less than {duration}')
-
-
-@then("the MiNiFi C2 server logs contain the following message: \"{log_message}\" in less than {duration}")
-def step_impl(context: MinifiTestContext, log_message: str, duration: str):
-    duration_seconds = humanfriendly.parse_timespan(duration)
-    assert wait_for_condition(condition=lambda: log_message in context.containers["minifi-c2-server"].get_logs(),
-                              timeout_seconds=duration_seconds, bail_condition=lambda: context.containers["minifi-c2-server"].exited,
-                              context=context)

behave_framework/src/minifi_test_framework/steps/core_steps.py

@@ -30,7 +30,6 @@
 from minifi_test_framework.containers.directory import Directory
 from minifi_test_framework.containers.file import File
 from minifi_test_framework.core.minifi_test_context import DEFAULT_MINIFI_CONTAINER_NAME, MinifiTestContext
-from minifi_test_framework.containers.minifi_c2_server_container import MinifiC2Server
 
 
 @when("both instances start up")
@@ -115,33 +114,6 @@ def step_impl(context: MinifiTestContext):
     context.containers["nifi"] = NifiContainer(context)
 
 
-@given("C2 is enabled in MiNiFi")
-def step_impl(context: MinifiTestContext):
-    context.get_or_create_default_minifi_container().enable_c2()
-
-
 @given("flow configuration path is set up in flow url property")
 def step_impl(context: MinifiTestContext):
     context.get_or_create_default_minifi_container().fetch_flow_config_from_flow_url()
-
-
-@given("ssl properties are set up for MiNiFi C2 server")
-def step_impl(context: MinifiTestContext):
-    context.get_or_create_default_minifi_container().enable_c2_with_ssl()
-    context.get_or_create_default_minifi_container().set_up_ssl_properties()
-
-
-@given("a MiNiFi C2 server is set up")
-def step_impl(context: MinifiTestContext):
-    context.containers["minifi-c2-server"] = MinifiC2Server(context)
-
-
-@given("a MiNiFi C2 server is set up with SSL")
-def step_impl(context: MinifiTestContext):
-    context.containers["minifi-c2-server"] = MinifiC2Server(context, ssl=True)
-
-
-@given("a MiNiFi C2 server is started")
-def step_impl(context: MinifiTestContext):
-    context.containers["minifi-c2-server"] = MinifiC2Server(context)
-    assert context.containers["minifi-c2-server"].deploy()

…containers/minifi_c2_server_container.py …ures/steps/minifi_c2_server_container.pybehave_framework/src/minifi_test_framework/containers/minifi_c2_server_container.py renamed to extensions/standard-processors/tests/features/steps/minifi_c2_server_container.py behave_framework/src/minifi_test_framework/containers/minifi_c2_server_container.py renamed to extensions/standard-processors/tests/features/steps/minifi_c2_server_container.py

@@ -15,16 +15,19 @@
 #  limitations under the License.
 #
 
-from behave import step
+import humanfriendly
+from behave import step, then
 
 from minifi_test_framework.steps import checking_steps        # noqa: F401
 from minifi_test_framework.steps import configuration_steps   # noqa: F401
 from minifi_test_framework.steps import core_steps            # noqa: F401
 from minifi_test_framework.steps import flow_building_steps   # noqa: F401
 from minifi_test_framework.core.minifi_test_context import MinifiTestContext
+from minifi_test_framework.core.helpers import wait_for_condition
 from syslog_container import SyslogContainer
 from diag_slave_container import DiagSlave
 from tcp_client_container import TcpClientContainer
+from minifi_c2_server_container import MinifiC2Server
 
 
 @step("a Syslog client with TCP protocol is setup to send logs to minifi")
@@ -51,3 +54,52 @@ def step_impl(context: MinifiTestContext, modbus_cmd: str):
 @step('a TCP client is set up to send a test TCP message to minifi')
 def step_impl(context: MinifiTestContext):
     context.containers["tcp-client"] = TcpClientContainer(context)
+
+
+@given("C2 is enabled in MiNiFi")
+def step_impl(context: MinifiTestContext):
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.enable", "true")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.rest.url", f"http://minifi-c2-server-{context.scenario_id}:10090/c2/config/heartbeat")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.rest.url.ack", f"http://minifi-c2-server-{context.scenario_id}:10090/c2/config/acknowledge")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.flow.base.url", f"http://minifi-c2-server-{context.scenario_id}:10090/c2/config/")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.root.classes", "DeviceInfoNode,AgentInformation,FlowInformation,AssetInformation")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.full.heartbeat", "false")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.agent.class", "minifi-test-class")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.agent.identifier", "minifi-test-id")
+
+
+@given("ssl properties are set up for MiNiFi C2 server")
+def step_impl(context: MinifiTestContext):
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.enable", "true")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.rest.url", f"https://minifi-c2-server-{context.scenario_id}:10090/c2/config/heartbeat")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.rest.url.ack", f"https://minifi-c2-server-{context.scenario_id}:10090/c2/config/acknowledge")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.flow.base.url", f"https://minifi-c2-server-{context.scenario_id}:10090/c2/config/")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.root.classes", "DeviceInfoNode,AgentInformation,FlowInformation,AssetInformation")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.full.heartbeat", "false")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.agent.class", "minifi-test-class")
+    context.get_or_create_default_minifi_container().set_property("nifi.c2.agent.identifier", "minifi-test-id")
+    context.get_or_create_default_minifi_container().set_up_ssl_properties()
+
+
+@given("a MiNiFi C2 server is set up")
+def step_impl(context: MinifiTestContext):
+    context.containers["minifi-c2-server"] = MinifiC2Server(context)
+
+
+@given("a MiNiFi C2 server is set up with SSL")
+def step_impl(context: MinifiTestContext):
+    context.containers["minifi-c2-server"] = MinifiC2Server(context, ssl=True)
+
+
+@given("a MiNiFi C2 server is started")
+def step_impl(context: MinifiTestContext):
+    context.containers["minifi-c2-server"] = MinifiC2Server(context)
+    assert context.containers["minifi-c2-server"].deploy()
+
+
+@then("the MiNiFi C2 server logs contain the following message: \"{log_message}\" in less than {duration}")
+def step_impl(context: MinifiTestContext, log_message: str, duration: str):
+    duration_seconds = humanfriendly.parse_timespan(duration)
+    assert wait_for_condition(condition=lambda: log_message in context.containers["minifi-c2-server"].get_logs(),
+                              timeout_seconds=duration_seconds, bail_condition=lambda: context.containers["minifi-c2-server"].exited,
+                              context=context)