Refinement: Removed Redundancy of Scan Config Passing #304
Conversation
src/gcp_scanner/scanner.py
Outdated
| @@ -180,8 +180,10 @@ def get_crawl( | |||
| Returns: | |||
| scan_result: a dictionary with scanning results | |||
| """ | |||
|
|
|||
| res = crawler.crawl(project_id, client, crawler_config) | |||
| if crawler.crawler_config: | |||
There was a problem hiding this comment.
You are not actually calling the function here. This statement will always return true.
There was a problem hiding this comment.
If you are referencing about the crawler_config not having parentheses denoting a function, it is because the crawler_config method is a property, and properties in Python are typically accessed without parentheses.
The above testing image shows that, when the scanner is run, it is not always giving true for crawler_config. False for every class except of StorageBucketsCrawler (As for now only that class needs the config file).
Please let me know, if I have misunderstood your comment or something else was wrong.
There was a problem hiding this comment.
Oh my bad, right. NVM. I'd rename the function to make it more clear of what is this property about. Right now we have too many crawler_configs in the code.
There was a problem hiding this comment.
Yes, fair point. I have made the changes, changed the name to has_config_dependency from crawler_config
Thank you for going through my PR, and reviewing it. I think, I have done the relevant changes as asked. Please let me know in case any others are needed. |
src/gcp_scanner/scanner.py
Outdated
| @@ -180,8 +180,10 @@ def get_crawl( | |||
| Returns: | |||
| scan_result: a dictionary with scanning results | |||
| """ | |||
|
|
|||
| res = crawler.crawl(project_id, client, crawler_config) | |||
| if crawler.crawler_config: | |||
There was a problem hiding this comment.
Oh my bad, right. NVM. I'd rename the function to make it more clear of what is this property about. Right now we have too many crawler_configs in the code.
Pushed with the changes 😁 |
Description
crawler_configin base classICrawlerwhich is returns bool value, wheredefault=Falsecrawler_configin the base class needs to be overridden in the sub class to return True.Note : Currently as I was checking all the crawlers, I have just seen that config is being used only inside the
StorageBucketsCrawlercrawler. So only its value is set as True in its base class.Changes Made
ICrawlerhas a new property called ascrawler_configwhich returns the abstracted private variable_config_depndencywhich is set to False by default.StorageBucketsCrawlerclass has overriddencrawler_configto return True.get_crawlfunction in scanner.py has a check now calling thecrawler_configto decide to send config or not.Testing
Local testing done with logs denoting that where config file is sent and where it is not. (Removed the logs after the testing)
This check denotes that only
StorageBucketsCrawleris being sent the config file