Adding functionality to set same token value across cluster

[shivamdurgbuns]

This is for Vault Configuration.
fixes: https://issues.redhat.com/browse/OCSQE-1636

[shylesh]

lgtm

[shivamdurgbuns]

Job ran: https://ocs4-jenkins-csb-odf-qe.apps.ocp-c1.prod.psi.redhat.com/view/DR/job/qe-rdr-setup/1360/

[shivamdurgbuns]

deployment job: https://ocs4-jenkins-csb-odf-qe.apps.ocp-c1.prod.psi.redhat.com/view/DR/job/qe-rdr-setup/1371/

[shivamdurgbuns]

Verification job: https://ocs4-jenkins-csb-odf-qe.apps.ocp-c1.prod.psi.redhat.com/job/qe-rdr-setup/1391/

[clacroix12]

Couple things here:

• changed set_vault_token from a staticmethod to a standard method since we need an instance reference.
• changed the name to get_vault_token and updated the docstring since we are returning the value

[clacroix12]

Suggested change

	self.vault_path_token = self.set_vault_token(self)
	self.vault_path_token = self.get_vault_token()

This approach will not work

[petr-balogh]

Suggested change

	self.vault_path_token = self.generate_vault_token()
	Vault.vault_path_token = self.generate_vault_token()

You need to change class variable, not instance variable here otherwise it will not work.

I checked example you shared with me and little update to prove the uuid will be same in both calls and it's not:

import uuid

class Vault():
    vault_path_token = None

    def __init__(self):
        self.vault_path_token = Vault.vault_path_token

    def get_vault_token(self):
        """
        Get the Vault token value. Generate it first if it does not already exist.
        Returns:
            str: Vault token
        """
        if self.vault_path_token is None:
            self.vault_path_token = self.generate_vault_token()
        return self.vault_path_token

    def deploy(self):
        self.vault_path_token = self.get_vault_token()

    def generate_vault_token(self):
        print("inside generate_vault_token")
        # Generate a unique random value
        return str(uuid.uuid4())


v1 = Vault()
print(v1.vault_path_token)
v1.deploy()
print(v1.vault_path_token)

v2 = Vault()
v2.deploy()
print(v2.vault_path_token)

Output:

None
inside generate_vault_token
368f386a-dce3-4370-b60a-4309acf26fed
inside generate_vault_token
393d3edc-46a7-493c-b45c-8037e731924c

You clearly see it's different number - but we need to achieve to have same for both instances

Updated working code

import uuid

class Vault():
    vault_path_token = None

    def __init__(self):
        self.vault_path_token = Vault.vault_path_token

    def get_vault_token(self):
        """
        Get the Vault token value. Generate it first if it does not already exist.
        Returns:
            str: Vault token
        """
        if self.vault_path_token is None:
            Vault.vault_path_token = self.generate_vault_token()
        return Vault.vault_path_token

    def deploy(self):
        self.vault_path_token = self.get_vault_token()

    def generate_vault_token(self):
        print("inside generate_vault_token")
        # Generate a unique random value
        return str(uuid.uuid4())


v1 = Vault()
print(v1.vault_path_token)
v1.deploy()
print(v1.vault_path_token)

v2 = Vault()
v2.deploy()
print(v2.vault_path_token)

Output:

None
inside generate_vault_token
ba5e5c53-f49c-4fb4-b5c4-22c4f945ec1d
ba5e5c53-f49c-4fb4-b5c4-22c4f945ec1d

You see we have same here.

[shivamdurgbuns]

thanks for proof check, udpated

[shivamdurgbuns]

PR validation job: https://jenkins-csb-odf-qe-ocs4.dno.corp.redhat.com/job/qe-rdr-setup/1455/

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: petr-balogh, shivamdurgbuns

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[dahorak]

If I didn't miss anything, every time you will call get_vault_token from the firstly created Vault object, you will get new token - because you are checking it in the object parameterself.vault_path_token but updating it in the class variable Vault.vault_path_token. Is that intentional? Or did I miss something there?

[dahorak]

The easiest solution here, would be to save the newly generated token to both Vault.vault_path_token and self.vault_path_token directly in the get_vault_token method, but it would be quite ugly solution I think.

The best solution might be to make self.vault_path_token a property, which would check and return the Vault.vault_path_token and prospectively call the self.generate_vault_token() if needed (the code of the property will be very similar as the get_vault_token - except it will use Vault.vault_path_token everywhere and the get_vault_token could be removed.)

Something like this:

@property
def vault_path_token(self):
    if Vault.vault_path_token is None:
        Vault.vault_path_token = self.generate_vault_token()
    return Vault.vault_path_token

and prospectively:

@vault_path_token.setter
def vault_path_token(self, value):
    Vault.vault_path_token = value

but the setter might not be needed.

And you will have to remove the line ~599:

self.vault_path_token = self.get_vault_token()

[dahorak]

As mentioned above, the existing get_vault_token method will not work consistently and in some circumstances it might generate new value for for each execution.