From 6ac62c6053b446ab22d8225756d9a05313cadd63 Mon Sep 17 00:00:00 2001
From: JorgeEcheva26 <jorge.echevarriauribarri.practicas@telefonica.es>
Date: Thu, 19 Sep 2024 10:37:48 +0200
Subject: [PATCH] Cambio de nombre fichero emulator - > utilities y cambio del
 readme

---
 README.md                                       | 3 ++-
 scripts/deregister_and_login.py                 | 4 ++--
 scripts/invoker_capif_connector.py              | 4 ++--
 scripts/invoker_capif_connector_offboarding.py  | 4 ++--
 scripts/invoker_service_discovery.py            | 4 ++--
 scripts/invoker_service_get_token.py            | 4 ++--
 scripts/provider_capif_connector.py             | 4 ++--
 scripts/provider_capif_connector_offboarding.py | 4 ++--
 scripts/provider_get_all_published_api.py       | 4 ++--
 scripts/provider_get_published_api.py           | 4 ++--
 scripts/provider_publish_api.py                 | 6 +++---
 scripts/provider_unpublish_api.py               | 4 ++--
 scripts/provider_update_api.py                  | 6 +++---
 scripts/register_and_login.py                   | 4 ++--
 scripts/{emulator_utils.py => utilities.py}     | 0
 15 files changed, 30 insertions(+), 29 deletions(-)
 rename scripts/{emulator_utils.py => utilities.py} (100%)

diff --git a/README.md b/README.md
index 50179af..eeed018 100644
--- a/README.md
+++ b/README.md
@@ -106,7 +106,7 @@ pip install -r requirements.txt
 
 # How to use OpenCAPIF SDK
 
-1 - First it is required to complete the emulator utils file with the absolute paths of target environment in order to complete the configuration of the SDK:
+1 - First it is required to complete the utilities file with the absolute paths of target environment in order to complete the configuration of the SDK:
 - NOTE register file is not needed for the use of the SDK,
 - NOTE provider_exposer_get_sample_api_description_path is mandatory if publish functionalities are required.
 
@@ -156,6 +156,7 @@ IMPORTANT: In order to leverage OpenCAPIF SDK it is required to have registered
 
     "debug_mode": Boolean | If you want to recieve logs from SDK-S6G Example:True/False
     
+This configuration could also be fullfilled by enviroment variables
 
 Mandatory fields no matter the target role to be onboarded, either invoker or provider:
 
diff --git a/scripts/deregister_and_login.py b/scripts/deregister_and_login.py
index 317c9bb..efaa090 100644
--- a/scripts/deregister_and_login.py
+++ b/scripts/deregister_and_login.py
@@ -2,7 +2,7 @@ import json
 import logging
 import requests
 import urllib3
-import emulator_utils
+import utilities
 from requests.auth import HTTPBasicAuth
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
@@ -19,7 +19,7 @@ logging.basicConfig(
 
 def main():
     
-    variables=__load_config_file(config_file=emulator_utils.get_register_file())
+    variables=__load_config_file(config_file=utilities.get_register_file())
     log_result = __log_to_capif(variables)
     admintoken = log_result["access_token"]
     de_register_from_capif(admintoken,variables)
diff --git a/scripts/invoker_capif_connector.py b/scripts/invoker_capif_connector.py
index 61fd399..abc7ae7 100755
--- a/scripts/invoker_capif_connector.py
+++ b/scripts/invoker_capif_connector.py
@@ -1,7 +1,7 @@
 
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -17,7 +17,7 @@ def showcase_capif_connector():
         
     """
 
-    capif_connector = CAPIFInvokerConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFInvokerConnector(config_file=utilities.get_config_file())
 
     capif_connector.register_and_onboard_Invoker()
     print("COMPLETED")
diff --git a/scripts/invoker_capif_connector_offboarding.py b/scripts/invoker_capif_connector_offboarding.py
index 9466089..cceed63 100755
--- a/scripts/invoker_capif_connector_offboarding.py
+++ b/scripts/invoker_capif_connector_offboarding.py
@@ -2,7 +2,7 @@
 
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -14,7 +14,7 @@ from sdk import CAPIFInvokerConnector
 
 
 def showcase_offboard_and_deregister_invoker():
-    capif_connector = CAPIFInvokerConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFInvokerConnector(config_file=utilities.get_config_file())
     capif_connector.offboard_and_deregister_Invoker()
     print("COMPLETED")
 
diff --git a/scripts/invoker_service_discovery.py b/scripts/invoker_service_discovery.py
index 744d2a0..05fc4b3 100755
--- a/scripts/invoker_service_discovery.py
+++ b/scripts/invoker_service_discovery.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,7 +13,7 @@ from sdk import ServiceDiscoverer
 
 
 def showcase_access_token_retrieval_from_capif():
-    service_discoverer = ServiceDiscoverer(config_file=emulator_utils.get_config_file())
+    service_discoverer = ServiceDiscoverer(config_file=utilities.get_config_file())
     service_discoverer.discover()
     
 
diff --git a/scripts/invoker_service_get_token.py b/scripts/invoker_service_get_token.py
index 6621491..cc87de6 100755
--- a/scripts/invoker_service_get_token.py
+++ b/scripts/invoker_service_get_token.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -14,7 +14,7 @@ from sdk import ServiceDiscoverer
 
 
 def showcase_access_token_retrieval_from_capif():
-    service_discoverer = ServiceDiscoverer(config_file=emulator_utils.get_config_file())
+    service_discoverer = ServiceDiscoverer(config_file=utilities.get_config_file())
     service_discoverer.get_tokens()
     
 
diff --git a/scripts/provider_capif_connector.py b/scripts/provider_capif_connector.py
index b2fb5d0..1df3d21 100755
--- a/scripts/provider_capif_connector.py
+++ b/scripts/provider_capif_connector.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,7 +13,7 @@ def showcase_capif_nef_connector():
     """
 
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
 
     capif_connector.register_and_onboard_provider()
 
diff --git a/scripts/provider_capif_connector_offboarding.py b/scripts/provider_capif_connector_offboarding.py
index 18fc3a7..93028bb 100755
--- a/scripts/provider_capif_connector_offboarding.py
+++ b/scripts/provider_capif_connector_offboarding.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,7 +13,7 @@ from sdk import CAPIFProviderConnector
 def offboard_capif_nef_connector():
     """
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
     capif_connector.offboard_and_deregister_nef()
     print("COMPLETED")
 
diff --git a/scripts/provider_get_all_published_api.py b/scripts/provider_get_all_published_api.py
index 6404463..5e7b046 100644
--- a/scripts/provider_get_all_published_api.py
+++ b/scripts/provider_get_all_published_api.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,7 +13,7 @@ def showcase_capif_nef_connector():
     """
 
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
 
     capif_connector.get_all_services()
     print("COMPLETED")
diff --git a/scripts/provider_get_published_api.py b/scripts/provider_get_published_api.py
index aa603c2..6876707 100644
--- a/scripts/provider_get_published_api.py
+++ b/scripts/provider_get_published_api.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,7 +13,7 @@ def showcase_capif_nef_connector():
     """
 
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
 
     capif_connector.get_service()
     print("COMPLETED")
diff --git a/scripts/provider_publish_api.py b/scripts/provider_publish_api.py
index 694326e..68af744 100644
--- a/scripts/provider_publish_api.py
+++ b/scripts/provider_publish_api.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,10 +13,10 @@ def showcase_capif_nef_connector():
     """
 
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
 
     capif_connector.publish_services(
-        service_api_description_json_full_path=emulator_utils.provider_exposer_get_sample_api_description_path())
+        service_api_description_json_full_path=utilities.provider_exposer_get_sample_api_description_path())
     print("COMPLETED")
 
 if __name__ == "__main__":
diff --git a/scripts/provider_unpublish_api.py b/scripts/provider_unpublish_api.py
index 6e9305a..607a980 100644
--- a/scripts/provider_unpublish_api.py
+++ b/scripts/provider_unpublish_api.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,7 +13,7 @@ def showcase_capif_nef_connector():
     """
 
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
 
     capif_connector.unpublish_service()
     print("COMPLETED")
diff --git a/scripts/provider_update_api.py b/scripts/provider_update_api.py
index 6e7b18e..bdebaa0 100644
--- a/scripts/provider_update_api.py
+++ b/scripts/provider_update_api.py
@@ -1,6 +1,6 @@
 import sys
 import os
-import emulator_utils
+import utilities
 
 # Añadir el directorio del SDK al PYTHONPATH usando una ruta relativa
 script_dir = os.path.dirname(os.path.abspath(__file__))  # Directorio actual del script
@@ -13,10 +13,10 @@ def showcase_capif_nef_connector():
     """
 
     """
-    capif_connector = CAPIFProviderConnector(config_file=emulator_utils.get_config_file())
+    capif_connector = CAPIFProviderConnector(config_file=utilities.get_config_file())
 
     capif_connector.update_service(
-        service_api_description_json_full_path=emulator_utils.provider_exposer_get_sample_api_description_path())
+        service_api_description_json_full_path=utilities.provider_exposer_get_sample_api_description_path())
     print("COMPLETED")
 
 if __name__ == "__main__":
diff --git a/scripts/register_and_login.py b/scripts/register_and_login.py
index 30e66fc..fdc0cc4 100644
--- a/scripts/register_and_login.py
+++ b/scripts/register_and_login.py
@@ -2,7 +2,7 @@ import json
 import logging
 import requests
 import urllib3
-import emulator_utils
+import utilities
 from requests.auth import HTTPBasicAuth
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
@@ -19,7 +19,7 @@ logging.basicConfig(
 
 def main():
     
-    variables=__load_config_file(config_file=emulator_utils.get_register_file())
+    variables=__load_config_file(config_file=utilities.get_register_file())
     log_result = __log_to_capif(variables)
     admintoken = log_result["access_token"]
     postcreation = __create_user(admintoken,variables)
diff --git a/scripts/emulator_utils.py b/scripts/utilities.py
similarity index 100%
rename from scripts/emulator_utils.py
rename to scripts/utilities.py
-- 
GitLab