PAF-18 #Replace common URLs with constants

Author: Philipose

dynatrace/cluster/sso.py

@@ -1,6 +1,8 @@
 """SSO Operations for Dynatrace"""
 import dynatrace.requests.request_handler as rh
 
+ENDPOINT = "sso/ssoProvider"
+
 def disable_sso (cluster):
   """Disable SSO Sign-in"""
   disable_payload = {
@@ -10,7 +12,7 @@ def disable_sso (cluster):
       "ssoGroupsEnabled": False,
       "ssoLoginDisabled": True
   }
-  response = rh.cluster_post(cluster, "sso/ssoProvider", json=disable_payload)
+  response = rh.cluster_post(cluster, ENDPOINT, json=disable_payload)
   return response.status_code
 
 def enable_sso(cluster, disable_local=False, groups_enabled=False, is_openid=False):
@@ -30,9 +32,9 @@ def enable_sso(cluster, disable_local=False, groups_enabled=False, is_openid=Fal
   if is_openid:
     enable_payload['ssoProvider'] = "OIDC"
 
-  response = rh.cluster_post(cluster, "sso/ssoProvider", json=enable_payload)
+  response = rh.cluster_post(cluster, ENDPOINT, json=enable_payload)
   return response.status_code
 
 def get_sso_status (cluster):
-  response = rh.cluster_get(cluster, "sso/ssoProvider")
+  response = rh.cluster_get(cluster, ENDPOINT)
   return response.json()

dynatrace/requests/request_handler.py

@@ -4,6 +4,11 @@
 import requests
 from urllib3.exceptions import InsecureRequestWarning
 
+HTTPS_STR = "https://"
+CLUSTER_V1_PATH = "/api/v1.0/onpremise/"
+ENV_API_V1 = "/api/v1/"
+CONFIG_API_V1 = "/api/config/v1/"
+
 OLD_MERGE_ENVIRONMENT_SETTINGS = requests.Session.merge_environment_settings
 
 @contextlib.contextmanager
@@ -56,7 +61,7 @@ def sanitize_endpoint (endpoint):
 
 def generate_tenant_url(cluster, tenant):
   """Generate URL based on SaaS or Managed"""
-  url = "https://"
+  url = HTTPS_STR
   if cluster["is_managed"]:
     url = url + cluster['url'] + "/e/" + cluster['tenant'][tenant]
   else:
@@ -76,7 +81,7 @@ def cluster_get(cluster, endpoint, params=None):
     params['Api-Token'] = cluster['cluster_token']
 
     response = requests.get(
-        "https://" + cluster['url'] + "/api/v1.0/onpremise/" + endpoint,
+        HTTPS_STR + cluster['url'] + CLUSTER_V1_PATH + endpoint,
         params=params,
         verify=False
     )
@@ -97,7 +102,7 @@ def cluster_post(cluster, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['cluster_token']
 
     response =  requests.post(
-        "https://" + cluster['url'] + "/api/v1.0/onpremise/" + endpoint,
+        HTTPS_STR + cluster['url'] + CLUSTER_V1_PATH + endpoint,
         params=params,
         json=json,
         verify=False
@@ -118,7 +123,7 @@ def cluster_put(cluster, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['cluster_token']
 
     response =  requests.put(
-        "https://" + cluster['url'] + "/api/v1.0/onpremise/" + endpoint,
+        HTTPS_STR + cluster['url'] + CLUSTER_V1_PATH + endpoint,
         params=params,
         json=json,
         verify=False
@@ -138,7 +143,7 @@ def cluster_delete(cluster, endpoint, params=None, json=None):
   with no_ssl_verification():
     params['Api-Token'] = cluster['cluster_token']
     response =  requests.delete(
-        "https://" + cluster['url'] + "/api/v1.0/onpremise/" + endpoint,
+        HTTPS_STR + cluster['url'] + CLUSTER_V1_PATH + endpoint,
         params=params,
         json=json,
         verify=False
@@ -156,7 +161,7 @@ def env_get(cluster, tenant, endpoint, params=None):
   with no_ssl_verification():
     params['Api-Token'] = cluster['api_token'][tenant]
     response = requests.get(
-        generate_tenant_url(cluster, tenant) + "/api/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + ENV_API_V1 + endpoint,
         params=params,
         verify=False
     )
@@ -174,7 +179,7 @@ def env_post(cluster, tenant, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['api_token'][tenant]
 
     response = requests.post(
-        generate_tenant_url(cluster, tenant) + "/api/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + ENV_API_V1 + endpoint,
         params=params,
         verify=False,
         json=json
@@ -193,7 +198,7 @@ def env_put(cluster, tenant, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['api_token'][tenant]
 
     response = requests.put(
-        generate_tenant_url(cluster, tenant) + "/api/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + ENV_API_V1 + endpoint,
         params=params,
         verify=False,
         json=json
@@ -211,7 +216,7 @@ def env_delete(cluster, tenant, endpoint, params=None):
   with no_ssl_verification():
     params['Api-Token'] = cluster['api_token'][tenant]
     response = requests.delete(
-        generate_tenant_url(cluster, tenant) + "/api/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + ENV_API_V1 + endpoint,
         params=params,
         verify=False
     )
@@ -230,7 +235,7 @@ def config_get(cluster, tenant, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['api_token'][tenant]
 
     response = requests.get(
-        generate_tenant_url(cluster, tenant) + "/api/config/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + CONFIG_API_V1 + endpoint,
         params=params,
         verify=False,
         json=json
@@ -249,7 +254,7 @@ def config_post(cluster, tenant, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['api_token'][tenant]
 
     response = requests.post(
-        generate_tenant_url(cluster, tenant) + "/api/config/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + CONFIG_API_V1 + endpoint,
         params=params,
         verify=False,
         json=json
@@ -268,7 +273,7 @@ def config_put(cluster, tenant, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['api_token'][tenant]
 
     response = requests.put(
-        generate_tenant_url(cluster, tenant) + "/api/config/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + CONFIG_API_V1 + endpoint,
         params=params,
         verify=False,
         json=json
@@ -287,7 +292,7 @@ def config_delete(cluster, tenant, endpoint, params=None, json=None):
     params['Api-Token'] = cluster['api_token'][tenant]
 
     response = requests.delete(
-        generate_tenant_url(cluster, tenant) + "/api/config/v1/" + endpoint,
+        generate_tenant_url(cluster, tenant) + CONFIG_API_V1 + endpoint,
         params=params,
         verify=False,
         json=json

dynatrace/tenant/maintenance.py

@@ -4,6 +4,9 @@
 import dynatrace.requests.request_handler as rh
 import user_variables as uv
 
+
+MZ_ENDPOINT = "/maintenanceWindows/"
+
 class InvalidDateFormatException(ValueError):
   def __init__(self, required_format):
     self.required_format = required_format
@@ -114,28 +117,28 @@ def generate_schedule(recurrence_type, start_time, duration, range_start, range_
 
 def create_window (cluster, tenant, json):
   """Create Maintenance Window"""
-  response = rh.config_post(cluster, tenant, '/maintenanceWindows', json=json)
+  response = rh.config_post(cluster, tenant, MZ_ENDPOINT, json=json)
   return response.status_code
 
 def update_window (cluster, tenant, window_id, json):
   """Update Maintenance Window"""
-  response = rh.config_put(cluster, tenant, '/maintenanceWindows/' + window_id, json=json)
+  response = rh.config_put(cluster, tenant, MZ_ENDPOINT + window_id, json=json)
   return response.status_code
 
 def delete_window (cluster, tenant, window_id):
   """Delete Maintenance Window"""
-  response = rh.config_delete(cluster, tenant, '/maintenanceWindows/' + window_id)
+  response = rh.config_delete(cluster, tenant, MZ_ENDPOINT + window_id)
   return response.status_code
 
 def get_windows (cluster, tenant):
   """Return List of Maintenance Windows in Effect"""
-  response = rh.config_get(cluster, tenant, '/maintenanceWindows')
+  response = rh.config_get(cluster, tenant, MZ_ENDPOINT)
   return response.json()
 
 
 def get_window (cluster, tenant, window_id):
   """Return Maintenance Window Details"""
-  response = rh.config_get(cluster, tenant, '/maintenanceWindows/' + window_id)
+  response = rh.config_get(cluster, tenant, MZ_ENDPOINT + window_id)
   return response.json()
 
 def parse_tag(tag_string):

dynatrace/tenant/request_attributes.py

@@ -3,10 +3,12 @@
 import json
 from dynatrace.requests import request_handler as rh
 
+ENDPOINT = "/service/requestAttributes/"
+
 def pull_to_files(cluster, tenant, ignore_disabled=True):
   """Pull files from an environment to local"""
   # API Calls needed: Pull RA, take the ID and pull the details of each RA
-  all_ra_call = rh.config_get(cluster, tenant, "/service/requestAttributes")
+  all_ra_call = rh.config_get(cluster, tenant, ENDPOINT)
   all_ra_json = all_ra_call.json()
   all_ra_json = all_ra_json['values']
   #print (json.dumps(all_ra_json, indent=2))
@@ -15,7 +17,7 @@ def pull_to_files(cluster, tenant, ignore_disabled=True):
     single_ra_call = rh.config_get(
         cluster,
         tenant,
-        "/service/requestAttributes/" + str(request_attribute['id'])
+        ENDPOINT + str(request_attribute['id'])
     )
     if single_ra_call.status_code == 200:
       single_ra_json = single_ra_call.json()
@@ -34,7 +36,7 @@ def push_from_files(file_list, cluster, tenant):
   """Push Request Attributes in JSONs to a tenant"""
 
   # Checks for Existing RAs to update them put request rather than a post that would fail
-  existing_ra_get = rh.config_get(cluster, tenant, "/service/requestAttributes")
+  existing_ra_get = rh.config_get(cluster, tenant, ENDPOINT)
   existing_ra_json = existing_ra_get.json()
   existing_ra_json = existing_ra_json['values']
   existing_ra_list = {}
@@ -48,14 +50,14 @@ def push_from_files(file_list, cluster, tenant):
         single_ra_post = rh.config_put(
             cluster,
             tenant,
-            "/service/requestAttributes/" + existing_ra_list[file],
+            ENDPOINT + existing_ra_list[file],
             json=ra_json
         )
       else:
         single_ra_post = rh.config_post(
             cluster,
             tenant,
-            "/service/requestAttributes",
+            ENDPOINT,
             json=ra_json
         )
       if single_ra_post.status_code >= 400:

dynatrace/timeseries/timeseries.py

@@ -1,20 +1,22 @@
 from dynatrace.requests import request_handler as rh
 
+ENDPOINT = "timeseries/"
+
 def get_timeseries_list(cluster, tenant, params=None):
   """Get List of Timeseries Metics"""
-  response = rh.env_get(cluster, tenant, "timeseries", params=params)
+  response = rh.env_get(cluster, tenant, ENDPOINT, params=params)
   return response.json()
 
 def get_timeseries_metric (cluster, tenant, metric, params=None):
   """Get Timeseries Metric"""
   #Chose to do GET, but could also be done as POST. Don't think there are any advantages to post
-  response = rh.env_get(cluster, tenant, "timeseries/" + metric, params=params)
+  response = rh.env_get(cluster, tenant, ENDPOINT + metric, params=params)
   return response.json()
 
 def create_custom_metric (cluster, tenant, metric, json, params=None):
-  response = rh.env_put(cluster, tenant, "timeseries/" + metric, params=params, json=json)
+  response = rh.env_put(cluster, tenant, ENDPOINT + metric, params=params, json=json)
   return response.status_code
 
 def delete_custom_metic (cluster, tenant, metric):
-  response = rh.env_delete(cluster, tenant, "timeseries/" + metric)
+  response = rh.env_delete(cluster, tenant, ENDPOINT + metric)
   return response.status_code

dynatrace/topology/applications.py

@@ -2,19 +2,21 @@
 # Applications needs a seperate definition since the url is not the same (not /infrastructre/)
 from dynatrace.requests import request_handler as rh
 
+ENDPOINT = "entity/applications/"
+
 def get_applications_tenantwide(cluster, tenant):
   """Get Information for all applications in a tenant"""
-  response = rh.env_get(cluster, tenant, "entity/applications")
+  response = rh.env_get(cluster, tenant, ENDPOINT)
   return response.json()
 
 def get_application(cluster, tenant, entity):
   """Get Information on one application for in a tenant"""
-  response = rh.env_get(cluster, tenant, "entity/applications/" + entity)
+  response = rh.env_get(cluster, tenant, ENDPOINT + entity)
   return response.json()
 
 def set_application_properties(cluster, tenant, entity, prop_json):
   """Update properties of application entity"""
-  response = rh.env_post(cluster, tenant, "entity/applications/" + entity, json=prop_json)
+  response = rh.env_post(cluster, tenant, ENDPOINT + entity, json=prop_json)
   return response.json()
 
 def get_application_count_tenantwide(cluster, tenant):
@@ -24,7 +26,7 @@ def get_application_count_tenantwide(cluster, tenant):
       "includeDetails" : "false"
   }
 
-  response = rh.env_get(cluster, tenant, "entity/applications", params=params)
+  response = rh.env_get(cluster, tenant, ENDPOINT, params=params)
   env_app_count = len(response.json())
   return env_app_count
 
@@ -55,5 +57,5 @@ def add_application_tags (cluster, tenant, entity, tag_list):
 
 def get_application_baseline(cluster, tenant, entity):
   """Get baselines on one application for in a tenant"""
-  response = rh.env_get(cluster, tenant, "entity/applications/" + entity + "/baseline")
+  response = rh.env_get(cluster, tenant, ENDPOINT + entity + "/baseline")
   return response.json()

dynatrace/topology/shared.py

@@ -6,6 +6,8 @@
 # 2. Get specific entity - application, host process, process group, service
 # 3. Update properties of entity - application, custom, host, process group, service
 
+ENDPOINT = "entity/infrastructure/"
+
 def check_valid_layer(layer, layer_list):
   """Check if the operation is valid for the layer"""
   if layer is None or layer_list is None:
@@ -21,7 +23,7 @@ def get_env_layer_entities(cluster, tenant, layer, params=None):
   response = rh.env_get(
       cluster,
       tenant,
-      "entity/infrastructure/" + layer,
+      ENDPOINT + layer,
       params=params
   )
   return response.json()
@@ -33,7 +35,7 @@ def get_env_layer_entity(cluster, tenant, layer, entity, params=None):
   response = rh.env_get(
       cluster,
       tenant,
-      "entity/infrastructure/" + layer + "/" + entity,
+      ENDPOINT + layer + "/" + entity,
       params=params
   )
   return response.json()
@@ -45,7 +47,7 @@ def set_env_layer_properties(cluster, tenant, layer, entity, prop_json):
   response = rh.env_post(
       cluster,
       tenant,
-      "entity/infrastructure/" + layer + "/" + entity,
+      ENDPOINT + layer + "/" + entity,
       json=prop_json
   )
   return response.status_code
@@ -62,7 +64,7 @@ def get_env_layer_count(cluster, tenant, layer, params=None):
     params['includeDetails'] : "false"
 
   check_valid_layer(layer, layer_list)
-  response = rh.env_get(cluster, tenant, "entity/infrastructure/" + layer, params=params)
+  response = rh.env_get(cluster, tenant, ENDPOINT + layer, params=params)
   env_layer_count = len(response.json())
   return env_layer_count