refactor: Changing the request header to a private field

Author: Robin-Van-de-Merghel

Pilot/pilotTools.py

@@ -709,11 +709,10 @@ def sendMessage(url, pilotUUID, wnVO, method, rawMessage):
                                   caPath=caPath,
                                   certEnv=cert)
 
+    X509config.generateUserAgent(pilotUUID=pilotUUID)
+    
     # Do the request
-    _res = X509config.executeRequest(raw_data=raw_data,
-                              headers={
-                                "User-Agent": X509config.generateUserAgent(pilotUUID=pilotUUID)
-                              })
+    _res = X509config.executeRequest(raw_data=raw_data)
 
 
 class CommandBase(object):

Pilot/proxyTools.py

@@ -86,6 +86,9 @@ def __init__(self, url, caPath, name="unknown"):
         self.name = name
         self.url = url
         self.caPath = caPath
+        self.headers = {
+            "User-Agent": "Dirac Pilot [Unknown ID]"
+        }
         # We assume we have only one context, so this variable could be shared to avoid opening n times a cert.
         # On the contrary, to avoid race conditions, we do avoid using "self.data" and "self.headers"
         self._context = None
@@ -97,19 +100,16 @@ def generateUserAgent(self, pilotUUID):
 
         :param pilotUUID: Unique ID of the Pilot
         :type pilotUUID: str
-        :type param_name: param_type
-        :return: The generated user agent
-        :rtype: str
         """
-        return "Dirac Pilot [%s]" % pilotUUID
+        self.headers["User-Agent"] = "Dirac Pilot [%s]" % pilotUUID
 
     def _prepareRequest(self):
         """As previously, loads the SSL certificates of the server (to avoid "unknown issuer")"""
         # Load the SSL context
         self._context = ssl.create_default_context()
         self._context.load_verify_locations(capath=self.caPath)
 
-    def executeRequest(self, raw_data, headers={"User-Agent": "Dirac Pilot [Unknown ID]"}):
+    def executeRequest(self, raw_data):
         """Execute a HTTP request with the data, headers, and the pre-defined data (SSL + auth)
 
         :param raw_data: Data to send
@@ -125,7 +125,7 @@ def executeRequest(self, raw_data, headers={"User-Agent": "Dirac Pilot [Unknown
             # Python2
             data = urlencode(raw_data)
 
-        request = Request(self.url, data=data, headers=headers)
+        request = Request(self.url, data=data, headers=self.headers)
 
         res = urlopen(request, context=self._context)
         res.close()
@@ -140,11 +140,10 @@ def __init__(self, url, caPath, jwtData):
         super(TokenBasedRequest, self).__init__(url, caPath, "TokenBasedConnection")
 
         self.jwtData = jwtData
-
-    def executeRequest(self, raw_data, headers={"User-Agent": "Dirac Pilot [Unknown ID]"}):
+    
+    def addJwtToHeader(self):
         # Adds the JWT in the HTTP request (in the Bearer field)
-        headers["Authorization"] = "Bearer: %s" % self.jwtData
-        return super(TokenBasedRequest, self).executeRequest(raw_data, headers)
+        self.headers["Authorization"] = "Bearer: %s" % self.jwtData
 
 
 class X509BasedRequest(BaseConnectedRequest):
@@ -165,8 +164,8 @@ def __init__(self, url, caPath, certEnv):
             )
             self._hasExtraCredentials = True
 
-    def executeRequest(self, raw_data, headers={"User-Agent": "Dirac Pilot [Unknown ID]"}):
+    def executeRequest(self, raw_data):
         # Adds a flag if the passed cert is a Directory
         if self._hasExtraCredentials:
             raw_data["extraCredentials"] = '"hosts"'
-        return super(X509BasedRequest, self).executeRequest(raw_data, headers)
+        return super(X509BasedRequest, self).executeRequest(raw_data)