Fix error when there's an empty 'mask' in bitops config

[PhillypHenning]

Description

Adding mask value check. If value is set, masking will occur, if not, message it returned unmasked. This avoid null value issues.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation

[arm4b]

For the record, this is a follow-up to #345 implementation where we get the following error:

#8 0.955   File "/opt/bitops/scripts/plugins/logging.py", line 84, in format
#8 0.955     record.msg = mask_message(record.msg)
#8 0.955   File "/opt/bitops/scripts/plugins/logging.py", line 44, in mask_message
#8 0.955     for config_item in BITOPS_logging_masks:
#8 0.955 TypeError: 'NoneType' object is not iterable

@PhillypHenning Is it happening when the mask: wasn't provided in the bitops config, right?

[PhillypHenning]

Yep!

[arm4b]

How about specifying the right default for the empty mask? I believe it's a list by default.

Maybe adding else [] instead of else None here would save us from future issues?

bitops/scripts/plugins/settings.py

Lines 126 to 130 in d5f625e

	BITOPS_logging_masks = (
	bitops_build_configuration.bitops.logging.masks
	if bitops_build_configuration.bitops.logging.masks is not None
	else None
	)

WDYT?

[arm4b]

Additionally, looks like we've missed adding new mask to bitops schema here:
https://github.com/bitovi/bitops/blob/main/bitops.schema.yaml

[PhillypHenning]

I disagree - personally if the value is "" then it should be a none type. None type checking is fast and accurate. Variables being half set isn't a great pattern.

[arm4b]

Yeah, I understand what you mean.
I just see similar errors in so many places as we're fixing those.

For instance, if schema says bitops: is an object, - yeah after parsing yaml technically empty value is None, but it's much better for us to consider it as an empty object/dict {}.

If schema says mask: is a list, technically empty value is None, but it's much better to consider it as an empty list [].

And because we have a schema with default types it makes more sense to justify it:

bitops/bitops.schema.yaml

Lines 40 to 45 in d5f625e

	source:
	type: object
	properties:
	sourced_from:
	type: string
	description: "Where the plugin will be sourced from"

So we're casting to the default type according to the schema that we defined previously.

Technically relying on None gives us nothing, but relying on the default schema type is much more beneficial saving us from all the type & empty check issues in the long run.

[PhillypHenning]

Alright based on https://github.com/bitovi/bitops/pull/345/files#diff-3ee44309834f418383ee2f058cfc22a2dd857c38b7c85ba42c835ae4d23e2163 which details the original masking work, am I right to assume what we're really needing here is a dict schema converter?

bitops.config.yaml

masks:
      - # regex to search
        # looks for `BITOPS_KUBECONFIG_BASE64={string}`
        search:  (.*BITOPS_KUBECONFIG_BASE64.*\=)(.*\n)
        # replace the value part
        replace: '\1*******\n'
      - # regex to search
        # looks for `The namespace kube-system exists`
        search:  (.*The namespace )(kube-system)( exists.*)
        #replace kube-system
        replace: '\1*******\3'

From my perspective this is either a list object or a dict.
Regardless, a converter will need to be written.

@armab @mickmcgrath13

[arm4b]

Looks like the masks is a list of dicts at this moment: masks: [{}, {}, {}].
What do you mean by converting?

I would care about the highest-level masks: [] default casting to the list for now for this specific case, as that's happening when the user is omitting the masks in the bitops config.

[arm4b]

Alright, let's merge it as is as it fixes an issue, - was still good to have a conversation here.
Thanks for creating a dedicated PR for the fix! 👍