Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update code for better use, addind delay and additional condition #150

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

XeniaP
Copy link

@XeniaP XeniaP commented Sep 19, 2023

Update Code

Change Summary

Adding delay in Check_Status to avoid response error on FSS Api
Adding 1 condition to handle the tags of S3 Buckets
Setting else condition to avoid duplicate tags for FSSMonited on add_tags method

PR Checklist

  • I've read and followed the Contributing Guide.
  • Documents/Readmes
    • Updated accordingly
    • [ x] Not required
  • Plugins that have versioning

Other Notes

Duplicate tags
image

API error response
image

@trend-jack-c-tang trend-jack-c-tang added the enhancement New feature or request label Sep 19, 2023
@trend-jack-c-tang trend-jack-c-tang requested a review from a team September 19, 2023 08:30
status = json.loads(st_call.data.decode('utf-8'))['status']
print("Status: " + status)
while status == 'creating':
st_call = http.request('GET', url , headers = {'Authorization': cloud_one_api_key, 'Api-Version': 'v1'})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part could also use the headers variable you declared as well.

Suggested change
st_call = http.request('GET', url , headers = {'Authorization': cloud_one_api_key, 'Api-Version': 'v1'})
st_call = http.request('GET', url, headers=headers)

@@ -310,10 +319,11 @@ Resources:
check_status(cloud_one_api_key, url)
#check storage stack status
def check_status(cloud_one_api_key, url):
time.sleep(10) #Adding delay to avoid response error in API
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a bit more about the response error mentioned here? and why you choose to use 10 seconds as the delay interval?

Comment on lines +246 to +248
else:
add_tag(s3_client, bucket_name, tag_list=tag_status) #move this inside if to avoid duplicate tags
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By moving the add_tag() and add_storage() inside the for loop means that every tag inside tag_status array that has a key != "FSSMonitored" will trigger the add_tag() and add_storage() once. I don't think this is what we wanted.

Suggested change
else:
add_tag(s3_client, bucket_name, tag_list=tag_status) #move this inside if to avoid duplicate tags
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
add_tag(s3_client, bucket_name, tag_list=tag_status) #move this inside if to avoid duplicate tags
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)

Comment on lines 240 to 242
elif tags["Value"].lower() != "yes":
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
break
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious, if the user gave an invalid FSSMonitored tag value like FSSMonitored: heehee, this plugin would still deploy the storage stack, right? In this case, should we also update their invalid FSSMonitored value to Yes instead of leaving it as heehee?

for tags in tag_status:
if tags["Key"] == "FSSMonitored":
print(tags["Value"].lower())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think we need this since the tag set logs will print out the detailed tag structure and values already.

add_tag(s3_client, bucket_name, tag_list=[])
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
else:
print("tag_Status2: ", tag_status)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we want to check the updated bucket tag after new tags were added, maybe consider adding the log at the end of add_tag() instead?

def add_tag(s3_client, bucket_name, tag_list):
    tag_list.append({'Key':'FSSMonitored', 'Value': 'Yes'})
    print(f"Bucket: {bucket_name} lacks an FSSMonitored tag; adding")
    s3_client.put_bucket_tagging(
        Bucket=bucket_name,
        Tagging={"TagSet": tag_list},
    )
    print("Updated bucket tag set: ", tag_list)

Comment on lines 220 to 227
except ClientError:
no_tags = "does not have tags"
tag_status = no_tags
if tag_status == "does not have tags":
print("does not have tags")
add_tag(s3_client, bucket_name, tag_list=[])
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
else:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can simplify the code by taking out the if condition when tag_status == "does not have tags" and just directly execute the actions inside the exception section like so:

Suggested change
except ClientError:
no_tags = "does not have tags"
tag_status = no_tags
if tag_status == "does not have tags":
print("does not have tags")
add_tag(s3_client, bucket_name, tag_list=[])
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
else:
except ClientError:
add_tag(s3_client, bucket_name, tag_list=[])
add_storage(cloud_one_api_key, bucket_name, ext_id, account_id, stack_id, kms_arn)
return 0

Comment on lines 218 to +219
tag_status = tags
print("tag_Status1: ", tag_status)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe consider logging sentences that are more readable:

Suggested change
tag_status = tags
print("tag_Status1: ", tag_status)
print("Bucket tag set: ", tags)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants