KEH-1220 - Add config file support

[smstone0]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

What

Adds a config file to allow for the following:

• Write data files locally instead of to S3.
• Output logging messages to a local debug.log file.

This allows for better testing without effecting the cloud environments and in use data.

Testing

Have any new tests been added as part of this issue? If not, try to explain why test coverage is not needed here.

• Yes
• No
  Please write a brief description of why test coverage is not necessary here.
• Not as part of this ticket. (Could be done at a later point)

Documentation

Has any new documentation been written as part of this issue? We should try to keep documentation up to date
as new code is added, rather than leaving it for the future.

• Yes
• No
  Please write a brief description of why documentation is not necessary here.
• Not as part of this ticket. (Could be done at a later point)

Related issues

KEH-1220 (Jira)

How to review

• Follow README guide to run the Lambda locally outside of a container (link).
• Change config.json to:

  {
    "features": {
      "show_log_locally": true,
      "write_data_locally": true
    }
  }

• Run the tool.

Once the script has finished running, you should expect to see a debug.log file and an output/ directory containing the 3 json files that get written to S3.

Double check that all the files exist and they have data in them.

[github-actions]

🦙 MegaLinter status: ⚠️ WARNING

Descriptor	Linter	Files	Fixed	Errors	Warnings	Elapsed time
⚠️ BASH	bash-exec	6		4	0	0.04s
✅ BASH	shellcheck	6		0	0	0.12s
✅ BASH	shfmt	6		0	0	0.01s
✅ CSHARP	csharpier	1		0	0	0.58s
✅ DOCKERFILE	hadolint	1		0	0	0.1s
✅ JSON	jsonlint	2		0	0	0.18s
✅ JSON	prettier	2		0	0	0.66s
✅ JSON	v8r	2		0	0	3.43s
✅ MARKDOWN	markdownlint	6		0	0	0.98s
✅ MARKDOWN	markdown-table-formatter	6		0	0	0.39s
✅ REPOSITORY	checkov	yes		no	no	26.25s
✅ REPOSITORY	dustilock	yes		no	no	0.02s
✅ REPOSITORY	gitleaks	yes		no	no	7.34s
✅ REPOSITORY	grype	yes		no	no	50.86s
✅ REPOSITORY	kics	yes		no	no	46.34s
✅ REPOSITORY	secretlint	yes		no	no	1.12s
✅ REPOSITORY	syft	yes		no	no	4.13s
✅ REPOSITORY	trivy	yes		no	no	12.65s
✅ REPOSITORY	trivy-sbom	yes		no	no	0.51s
✅ TERRAFORM	terraform-fmt	6		0	0	0.47s
✅ YAML	prettier	8		0	0	0.79s
✅ YAML	v8r	8		0	0	6.37s
✅ YAML	yamllint	8		0	0	0.54s

See detailed report in MegaLinter reports

You could have same capabilities but better runtime performances if you request a new MegaLinter flavor.

• Click here to request the new flavor

MegaLinter is graciously provided by OX Security

[sebtheo]

Minor comments.