Sourcery refactored main branch #22

sourcery-ai · 2023-07-30T05:23:01Z

Branch main refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the main branch, then run:

git fetch origin sourcery/main
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

Remove unnecessary whitespace

Remove blank lines after docstring

Fixing issue #3

MongoDB improvements

Version 0.32 released. Resolve issue #6

Blank lines should not contain any tabs or spaces.

Remove unnecessary whitespace

…ongodb Version 0.37. See CHANGELOG.md

Version 0.39. See CHANGELOG.md

Version 0.43. See CHANGELOG.md

Version 0.44. See CHANGELOG.md

sourcery-ai · 2023-07-30T05:23:03Z

certCheck.py

-    parser = argparse.ArgumentParser(description='Certificate Checker v' + scriptVersion)
+    parser = argparse.ArgumentParser(
+        description=f'Certificate Checker v{scriptVersion}'
+    )


Function parseArguments refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:04Z

certCheck.py

-    # Create the json script structure with all the meta data.
-    myData = myDetails.combineData(__certResults, __mySystemInfo, __scriptStartTime, __scriptEndTime)
-
-    return myData
+    return myDetails.combineData(
+        __certResults, __mySystemInfo, __scriptStartTime, __scriptEndTime
+    )


Function gatherData refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

This removes the following comments ( why? ):

# Create the json script structure with all the meta data.

sourcery-ai · 2023-07-30T05:23:04Z

certCheck.py

-        print(uploadTime + " - " + str(uploadResult))
+        print(f"{uploadTime} - {str(uploadResult)}")


Function processQueryFile refactored with the following changes:

Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:04Z

certCheck.py

-    if args.contextVariables:
-        contextVariables = 1
-    else:
-        contextVariables = 0
-
+    contextVariables = 1 if args.contextVariables else 0


Function processHostname refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:04Z

certificate/certificateModule.py

        # Determine which context to create
        if __hostinfo['options'] is not None and \
-                "local_untrusted_allow" in __hostinfo['options']:
+                    "local_untrusted_allow" in __hostinfo['options']:


Function certificateModule.getCertificate refactored with the following changes:

Use f-string instead of string concatenation [×5] (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:05Z

certificate/getCertificateChain.py

-        certSKI = __sslCertificate.extensions.get_extension_for_oid(ExtensionOID.SUBJECT_KEY_IDENTIFIER)
-
-        return certSKI
+        return __sslCertificate.extensions.get_extension_for_oid(
+            ExtensionOID.SUBJECT_KEY_IDENTIFIER
+        )


Function getCertificateChain.returnCertSKI refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-07-30T05:23:06Z

certificate/getCertificateChain.py

-                dataAIA = [x for x in certValue or []]
-                for item in dataAIA:
-                    if item.access_method._name == "caIssuers":
-                        aiaUriList.append(item.access_location._value)
-
+                dataAIA = list(certValue or [])
+                aiaUriList.extend(
+                    item.access_location._value
+                    for item in dataAIA
+                    if item.access_method._name == "caIssuers"
+                )


Function getCertificateChain.returnCertAIAList refactored with the following changes:

Replace identity comprehension with call to collection constructor (identity-comprehension)

Replace a for append loop with list extend (for-append-to-extend)

sourcery-ai · 2023-07-30T05:23:06Z

certificate/getCertificateChain.py

-        if __depth <= self.maxDepth:
-            # Retrive the AKI from the certificate.
-            certAKI = self.returnCertAKI(__sslCertificate)
-            # Retrieve the SKI from the certificate.
-            certSKI = self.returnCertSKI(__sslCertificate)
+        if __depth > self.maxDepth:
+            return
+        # Retrive the AKI from the certificate.
+        certAKI = self.returnCertAKI(__sslCertificate)
+        # Retrieve the SKI from the certificate.
+        certSKI = self.returnCertSKI(__sslCertificate)

            # Sometimes the AKI can be none. Lets handle this accordingly.
-            if certAKI is not None:
-                certAKIValue = certAKI._value.key_identifier
-            else:
-                certAKIValue = None
-
-            # Get the value of the SKI from certSKI
-            certSKIValue = certSKI._value.digest
-
-            # Sometimes the AKI can be none. Lets handle this accordingly.
-            if certAKIValue is not None:
-                aiaUriList = self.returnCertAIAList(__sslCertificate)
-                if aiaUriList != []:
-                    # Iterate through the aiaUriList list.
-                    for item in aiaUriList:
-                        # get the certificate for the item element.
-                        nextCert = self.getCertificateFromUri(item)
-
-                        # If the certificate is not none (great), append it to the certChain, increase the __depth and run the walkTheChain subroutine again.
-                        if nextCert is not None:
-                            self.certChain.append(nextCert)
-                            __depth += 1
-                            self.walkTheChain(nextCert, __depth)
-                        else:
-                            print("Could not retrieve certificate.")
-                            sys.exit(1)
-                else:
-                    """Now we have to go on a hunt to find the root from a standard root store."""
-                    print("Certificate didn't have AIA...ruh roh.")
-
-                    # Load the Root CA Cert Chain.
-                    caRootStore = self.loadRootCACertChain("cacert.pem")
-
-                    # Assume we cannot find a Root CA
-                    rootCACN = None
-
-                    # Iterate through the caRootStore object.
-                    for rootCA in caRootStore:
-                        try:
-                            rootCACertificatePEM = caRootStore[rootCA]
-                            rootCACertificate = x509.load_pem_x509_certificate(rootCACertificatePEM.encode('ascii'))
-                            rootCASKI = self.returnCertSKI(rootCACertificate)
-                            rootCASKI_Value = rootCASKI._value.digest
-                            if rootCASKI_Value == certAKIValue:
-                                rootCACN = rootCA
-                                print(f"Root CA Found - {rootCACN}")
-                                self.certChain.append(rootCACertificate)
-                                break
-                        except x509.extensions.ExtensionNotFound:
-                            # Apparently some Root CA's don't have a SKI?
-                            pass
-
-                    if rootCACN is None:
-                        print("ERROR - Root CA NOT found.")
+        certAKIValue = certAKI._value.key_identifier if certAKI is not None else None
+        # Get the value of the SKI from certSKI
+        certSKIValue = certSKI._value.digest
+
+        # Sometimes the AKI can be none. Lets handle this accordingly.
+        if certAKIValue is not None:
+            aiaUriList = self.returnCertAIAList(__sslCertificate)
+            if aiaUriList != []:
+                # Iterate through the aiaUriList list.
+                for item in aiaUriList:
+                    # get the certificate for the item element.
+                    nextCert = self.getCertificateFromUri(item)
+
+                    # If the certificate is not none (great), append it to the certChain, increase the __depth and run the walkTheChain subroutine again.
+                    if nextCert is not None:
+                        self.certChain.append(nextCert)
+                        __depth += 1
+                        self.walkTheChain(nextCert, __depth)
+                    else:
+                        print("Could not retrieve certificate.")
                        sys.exit(1)
+            else:
+                """Now we have to go on a hunt to find the root from a standard root store."""
+                print("Certificate didn't have AIA...ruh roh.")
+
+                # Load the Root CA Cert Chain.
+                caRootStore = self.loadRootCACertChain("cacert.pem")
+
+                # Assume we cannot find a Root CA
+                rootCACN = None
+
+                # Iterate through the caRootStore object.
+                for rootCA in caRootStore:
+                    try:
+                        rootCACertificatePEM = caRootStore[rootCA]
+                        rootCACertificate = x509.load_pem_x509_certificate(rootCACertificatePEM.encode('ascii'))
+                        rootCASKI = self.returnCertSKI(rootCACertificate)
+                        rootCASKI_Value = rootCASKI._value.digest
+                        if rootCASKI_Value == certAKIValue:
+                            rootCACN = rootCA
+                            print(f"Root CA Found - {rootCACN}")
+                            self.certChain.append(rootCACertificate)
+                            break
+                    except x509.extensions.ExtensionNotFound:
+                        # Apparently some Root CA's don't have a SKI?
+                        pass
+
+                if rootCACN is None:
+                    print("ERROR - Root CA NOT found.")
+                    sys.exit(1)


Function getCertificateChain.walkTheChain refactored with the following changes:

Add guard clause (last-if-guard)

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2023-07-30T05:23:06Z

certificate/getCertificateChain.py

-        for counter, certificateItem in enumerate(myCertChain):
+        for certificateItem in myCertChain:


Function getCertificateChain.writeChainToFile refactored with the following changes:

Remove unnecessary calls to enumerate when the index is not used (remove-unused-enumerate)

sourcery-ai · 2023-07-30T05:23:06Z

data/calculateStats.py

-        for field in myDateTime:
-            if myDateTime[field] > 1:
+        for field, value in myDateTime.items():
+            if value > 1:
                humanReadable = f"{myDateTime[field]} {field}"
                timeYMDHMS.append(humanReadable)
-            else:
-                if myDateTime[field] == 1:
-                    humanReadable = f"{myDateTime[field]} {field[:-1]}"
-                    timeYMDHMS.append(humanReadable)
-        myDateTimeString = ', '.join(timeYMDHMS)
-
-        # Return the human readable form string.
-        return myDateTimeString
+            elif myDateTime[field] == 1:
+                humanReadable = f"{myDateTime[field]} {field[:-1]}"
+                timeYMDHMS.append(humanReadable)
+        return ', '.join(timeYMDHMS)


Function calculateStats.convertTimeIntoHumanReadable refactored with the following changes:

Use items() to directly unpack dictionary values (use-dict-items)

Inline variable that is immediately returned (inline-immediately-returned-variable)

Merge else clause's nested if statement into elif (merge-else-if-into-elif)

This removes the following comments ( why? ):

# Return the human readable form string.

sourcery-ai · 2023-07-30T05:23:09Z

data/calculateStats.py

-                if lowestCertificateTemplateTime > item["certificateTemplateTime"]:
-                    lowestCertificateTemplateTime = item["certificateTemplateTime"]
-
+                lowestCertificateTemplateTime = min(
+                    lowestCertificateTemplateTime, item["certificateTemplateTime"]
+                )
                # Calculate highest certificate template time.
-                if highestCertificateTemplateTime < item["certificateTemplateTime"]:
-                    highestCertificateTemplateTime = item["certificateTemplateTime"]
-
+                highestCertificateTemplateTime = max(
+                    highestCertificateTemplateTime, item["certificateTemplateTime"]
+                )


Function calculateStats.calculateStatistics refactored with the following changes:

Replace comparison with min/max call [×2] (min-max-identity)

sourcery-ai · 2023-07-30T05:23:10Z

data/calculateStats.py

-        # Create the json script structure with all the meta data.
-        myData = {
+        return {


Function calculateStats.combineData refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

This removes the following comments ( why? ):

# Create the json script structure with all the meta data.

sourcery-ai · 2023-07-30T05:23:10Z

data/certData.py

            tmpData = ['URL Redirects too many']
        except requests.exceptions.ConnectionError:
-            print('Could not connect to URL - ' + fileURL + '\n')
+            print(f'Could not connect to URL - {fileURL}' + '\n')


Function certData.getFileFromURL refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:10Z

data/certData.py

            line, options = line.split('[', 1)
            # Remove the closing bracket and convert to a list
-            options = ast.literal_eval('[' + options)
+            options = ast.literal_eval(f'[{options}')


Function certData.parse_line refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:10Z

data/certData.py

-        elif path.exists(queriesFile) and not (queriesFile.startswith('http://') or queriesFile.startswith('https://')):
+        elif (
+            path.exists(queriesFile)
+            and not queriesFile.startswith('http://')
+            and not queriesFile.startswith('https://')
+        ):
            with open(queriesFile, "r", encoding="utf-8") as f_queryFile:
                queryFile = f_queryFile.readlines()
                for line in queryFile:
                    hostEntry = certData.parse_line(line)
                    queries.append(hostEntry)
        else:
-            print('I cannot get file ' + queriesFile)
+            print(f'I cannot get file {queriesFile}')


Function certData.loadQueriesFile refactored with the following changes:

Simplify logical expression using De Morgan identities (de-morgan)

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2023-07-30T05:23:11Z

systemInfo/systemInfo.py

-        __myDeviceId = ""
-        if "myDeviceId" in self.myConfigJson:
-            __myDeviceId = self.myConfigJson["myDeviceId"]
-        return __myDeviceId
+        return (
+            self.myConfigJson["myDeviceId"]
+            if "myDeviceId" in self.myConfigJson
+            else ""
+        )


Function systemInfo.getDeviceId refactored with the following changes:

Move setting of default value for variable into else branch (introduce-default-else)

Replace if statement with if expression (assign-if-exp)

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-07-30T05:23:11Z

systemInfo/systemInfo.py

-        __myTags = []
-
-        # First check to see if the myTags element is in the myConfigJson variable.
-        if "myTags" in self.myConfigJson:
-            __myTags = self.myConfigJson["myTags"]
-
-        # Return the value of __myTags
-        return __myTags
+        return self.myConfigJson["myTags"] if "myTags" in self.myConfigJson else []


Function systemInfo.getTag refactored with the following changes:

Move setting of default value for variable into else branch (introduce-default-else)

Replace if statement with if expression (assign-if-exp)

Inline variable that is immediately returned (inline-immediately-returned-variable)

This removes the following comments ( why? ):

# First check to see if the myTags element is in the myConfigJson variable. # Return the value of __myTags

sourcery-ai · 2023-07-30T05:23:11Z

systemInfo/systemInfo.py

-        result = False
-        if "myTenantId" in __myConfigJson and __myConfigJson["myTenantId"] != "":
-            result = True
-        return result
+        return "myTenantId" in __myConfigJson and __myConfigJson["myTenantId"] != ""


Function systemInfo.checkMyTenantId refactored with the following changes:

Move setting of default value for variable into else branch (introduce-default-else)

Simplify boolean if expression (boolean-if-exp-identity)

Replace if statement with if expression (assign-if-exp)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2023-07-30T05:23:11Z

systemInfo/systemInfo.py

-        result = bool("myTags" in __myConfigJson)
-        return result
+        return "myTags" in __myConfigJson


Function systemInfo.checkMyTags refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

sourcery-ai · 2023-07-30T05:23:11Z

systemInfo/systemInfo.py

-        result = False
-        if "myDeviceId" in __myConfigJson and __myConfigJson["myDeviceId"] != "":
-            result = True
-        return result
+        return "myDeviceId" in __myConfigJson and __myConfigJson["myDeviceId"] != ""


Function systemInfo.checkMyDeviceId refactored with the following changes:

Move setting of default value for variable into else branch (introduce-default-else)

Simplify boolean if expression (boolean-if-exp-identity)

Replace if statement with if expression (assign-if-exp)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

Inline variable that is immediately returned (inline-immediately-returned-variable)

deepsource-autofix bot and others added 30 commits July 17, 2022 22:25

Remove unnecessary whitespace

a79fef7

Merge pull request #1 from TheScriptGuy/deepsource-fix-b7b3e255

bda1c36

Remove unnecessary whitespace

Remove blank lines after docstring

9b615c6

Merge pull request #2 from TheScriptGuy/deepsource-fix-b66fb2dd

b0ef14c

Remove blank lines after docstring

Fixing minor docstring syntax

9b67e27

Fixing issue #3

b759b78

Merge pull request #4 from TheScriptGuy/mongodb-keyerror

27d0673

Fixing issue #3

MongoDB improvements

468580c

MongoDB improvements

cc7ed7a

Merge pull request #5 from TheScriptGuy/mongodb-improvements

fd4c590

MongoDB improvements

Version 0.31. See CHANGELOG.md for updates.

c580ab7

Version 0.32 released. Resolve issue #6

d9bd4ca

Merge pull request #7 from TheScriptGuy/6-mongodb-upload-error

67fdd18

Version 0.32 released. Resolve issue #6

Version 0.33. See CHANGELOG.md

20476df

Python coding syntax updates

b5b7c39

Updating python syntax

07364d2

Version 0.34. See CHANGELOG.md

1657d25

Fixing syntax.

000dba9

Improving code syntax.

3308b3b

Improving code syntax.

6ab0089

Improving code syntax.

9e36649

Adding LICENSE.md

98d5550

Adding LICENSE.md

4ed0b17

Version 0.35. See CHANGELOG.md

0e44abd

Version 0.36. See CHANGELOG.md

c5aa789

refactor: Remove unnecessary whitespace

d002a58

Blank lines should not contain any tabs or spaces.

Merge pull request #10 from TheScriptGuy/deepsource-autofix-259a3969

af982be

Remove unnecessary whitespace

Version 0.37. See CHANGELOG.md

5002a49

Merge pull request #12 from TheScriptGuy/11-timestamp-error-message-m…

1964676

…ongodb Version 0.37. See CHANGELOG.md

Version 0.38. See CHANGELOG.md

cb4b998

Git and others added 25 commits April 15, 2023 15:34

Fixing syntax

66c77fd

Merge branch 'main' of github.com:TheScriptGuy/certificateChecker

b5f5c87

Fixing syntax

d44bfcc

Fixing syntax.

8239b55

Fixing syntax.

91dc9d4

Version 0.39. See CHANGELOG.md

ade61a3

Merge pull request #16 from TheScriptGuy/15-mongodb-operationfailure

0a463c4

Version 0.39. See CHANGELOG.md

Version 0.40. See CHANGELOG.md

27bd806

Version 0.41. See CHANGELOG.md

122f057

Minor bug fix with --hostname

c117a89

Version 0.42. See CHANGELOG.md

9d0a92a

fixing syntax.

2b78d0e

fixing syntax.

1e3beb1

Version 0.43. See CHANGELOG.md

85be754

Version 0.43. See CHANGELOG.md

8a868cf

Merge pull request #18 from TheScriptGuy/17-socket-timeout-feature

e13148b

Version 0.43. See CHANGELOG.md

Version 0.44. See CHANGELOG.md

b67d111

Version 0.44. See CHANGELOG.md

50932ed

Merge pull request #20 from TheScriptGuy/19-traceback-untrusted-issuer

6de8131

Version 0.44. See CHANGELOG.md

Version 0.44. See CHANGELOG.md

f525d6c

Merge pull request #21 from TheScriptGuy/19-traceback-untrusted-issuer

d36a65a

Version 0.44. See CHANGELOG.md

Version 0.45. See CHANGELOG.md

a8bb774

Version 0.46. See CHANGELOG.md

ee1b636

Aligning to PEP standards

0b57489

'Refactored by Sourcery'

7c99437

sourcery-ai bot requested a review from TheScriptGuy July 30, 2023 05:23

sourcery-ai bot commented Jul 30, 2023

View reviewed changes

TheScriptGuy force-pushed the main branch 2 times, most recently from 389d558 to da7c802 Compare January 7, 2024 01:12

		print(uploadTime + " - " + str(uploadResult))
		print(f"{uploadTime} - {str(uploadResult)}")

		for counter, certificateItem in enumerate(myCertChain):
		for certificateItem in myCertChain:

Sourcery refactored main branch #22

Are you sure you want to change the base?

Sourcery refactored main branch #22

Uh oh!

Conversation

sourcery-ai bot commented Jul 30, 2023

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 30, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants