From 1557b3d49e8ae01fcc52f805e84c235ac782c8fb Mon Sep 17 00:00:00 2001
From: kdoroszko-splunk <147069837+kdoroszko-splunk@users.noreply.github.com>
Date: Sat, 25 Nov 2023 13:29:56 +0100
Subject: [PATCH] feat: added --sc4s-version option (#802)

* feat: added --sc4s-version option

* ci: rename semgrep

* chore: refactor splunk fixture

* chore: code refinement by use of splunk_fixture variable

---------

Co-authored-by: Artem Rys <rysartem@gmail.com>
---
 .github/workflows/build-test-release.yml |  2 +-
 pytest_splunk_addon/splunk.py            | 59 +++++++++++++-----------
 2 files changed, 34 insertions(+), 27 deletions(-)

diff --git a/.github/workflows/build-test-release.yml b/.github/workflows/build-test-release.yml
index 09302ebf0..5d10a5ac3 100644
--- a/.github/workflows/build-test-release.yml
+++ b/.github/workflows/build-test-release.yml
@@ -68,7 +68,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - id: semgrep
-        uses: returntocorp/semgrep-action@v1
+        uses: semgrep/semgrep-action@v1
         with:
           publishToken: ${{ secrets.SEMGREP_PUBLISH_TOKEN }}
 
diff --git a/pytest_splunk_addon/splunk.py b/pytest_splunk_addon/splunk.py
index 6f8371da5..6c0f7607e 100644
--- a/pytest_splunk_addon/splunk.py
+++ b/pytest_splunk_addon/splunk.py
@@ -199,6 +199,13 @@ def pytest_addoption(parser):
         default="514",
         help="SC4S Port. default is 514",
     )
+    group.addoption(
+        "--sc4s-version",
+        action="store",
+        dest="sc4s_version",
+        default="latest",
+        help="SC4S version. default is latest",
+    )
     group.addoption(
         "--thread-count",
         action="store",
@@ -416,32 +423,12 @@ def splunk(request, file_system_prerequisite):
     """
     splunk_type = request.config.getoption("splunk_type")
     LOGGER.info("Get the Splunk instance of splunk_type=%s", splunk_type)
-    if splunk_type == "external":
-        request.fixturenames.append("splunk_external")
-        splunk_info = request.getfixturevalue("splunk_external")
-    elif splunk_type == "docker":
-        os.environ["SPLUNK_APP_PACKAGE"] = request.config.getoption("splunk_app")
-        try:
-            config = configparser.ConfigParser()
-            config.read(
-                os.path.join(
-                    request.config.getoption("splunk_app"),
-                    "default",
-                    "app.conf",
-                )
-            )
-            os.environ["SPLUNK_APP_ID"] = config["package"]["id"]
-        except Exception:
-            os.environ["SPLUNK_APP_ID"] = "TA_package"
-        os.environ["SPLUNK_HEC_TOKEN"] = request.config.getoption("splunk_hec_token")
-        os.environ["SPLUNK_USER"] = request.config.getoption("splunk_user")
-        os.environ["SPLUNK_PASSWORD"] = request.config.getoption("splunk_password")
-        os.environ["SPLUNK_VERSION"] = request.config.getoption("splunk_version")
-
-        request.fixturenames.append("splunk_docker")
-        splunk_info = request.getfixturevalue("splunk_docker")
-    else:
-        raise Exception
+    splunk_fixture = f"splunk_{splunk_type}"
+    try:
+        request.fixturenames.append(splunk_fixture)
+        splunk_info = request.getfixturevalue(splunk_fixture)
+    except Exception as e:
+        raise Exception(f"Failed to get Splunk fixture ({splunk_fixture}): {e}")
 
     yield splunk_info
 
@@ -540,6 +527,26 @@ def splunk_docker(
     Returns:
         dict: Details of the splunk instance including host, port, username & password.
     """
+    # configuration of environment variables needed by docker-compose file
+    os.environ["SPLUNK_APP_PACKAGE"] = request.config.getoption("splunk_app")
+    try:
+        config = configparser.ConfigParser()
+        config.read(
+            os.path.join(
+                request.config.getoption("splunk_app"),
+                "default",
+                "app.conf",
+            )
+        )
+        os.environ["SPLUNK_APP_ID"] = config["package"]["id"]
+    except Exception:
+        os.environ["SPLUNK_APP_ID"] = "TA_package"
+    os.environ["SPLUNK_HEC_TOKEN"] = request.config.getoption("splunk_hec_token")
+    os.environ["SPLUNK_USER"] = request.config.getoption("splunk_user")
+    os.environ["SPLUNK_PASSWORD"] = request.config.getoption("splunk_password")
+    os.environ["SPLUNK_VERSION"] = request.config.getoption("splunk_version")
+    os.environ["SC4S_VERSION"] = request.config.getoption("sc4s_version")
+
     LOGGER.info("Starting docker_service=splunk")
     if worker_id:
         # get the temp directory shared by all workers