Initial commits #1

jsf9k · 2021-12-28T17:02:40Z

🗣 Description

This pull request includes the initial functionality for this repository.

💭 Motivation and context

A repo must do something in order to be useful!

Resolves #2.

🧪 Testing

The testing here is admittedly not great, but the code has been used to:

Manually generate YML from the Markdown in cisagov/log4j-affected-db.
Manually generate Markdown from the YML generated in the previous item.

✅ Pre-approval checklist

This PR has an informative and human-readable title.
Changes are limited to a single goal - eschew scope creep!
All future TODOs are captured in issues, which are referenced in code comments.
All relevant type-of-change labels have been added.
I have read the CONTRIBUTING document.
These code changes follow cisagov code standards.
All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
Tests have been added and/or modified to cover the changes in this PR.
All new and existing tests pass.

✅ Pre-merge checklist

Bump to version 1.0.0.

✅ Post-merge checklist

Create a release.

- rename a bunch of example identifiers - remove uneeded files

Also remove types-setuptools, since it isn't being used.

…to first-commits

Coo coo cachoo!

Also duplicate that logic in a few other places where it is useful.

pytablewriter was creating very wide tables. there was not an easy way to make more condensed tables

I did not read the "note" that told me not to do the thang that I did.

@jsf9k

Thanks to @jsf9k for spotting this over my virtual shoulder. Co-authored-by: @jsf9k

…to first-commits

The new format can support information for multiple log4j-related CVEs.

mcdonnnj

First pass review with some suggestions and questions.

README.md

bump_version.sh

src/ymlmd/yml2md.py

src/mdyml/convert_cisagov.py

setup.py

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Change return value from Int to None Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

lgtm-com · 2021-12-29T21:59:59Z

This pull request introduces 1 alert and fixes 1 when merging 4e15437 into 9697906 - view on LGTM.com

new alerts:

1 for Syntax error

fixed alerts:

1 for Clear-text logging of sensitive information

…first-commits

lgtm-com · 2021-12-29T22:10:57Z

This pull request introduces 1 alert and fixes 1 when merging e48e22d into 9697906 - view on LGTM.com

new alerts:

1 for Syntax error

fixed alerts:

1 for Clear-text logging of sensitive information

Since we want to use the same version for all packages in this project it makes sense to define this at the root level instead of pulling in the version from one of the library's packages.

lgtm-com · 2021-12-29T22:45:48Z

This pull request introduces 1 alert and fixes 1 when merging 5e53e83 into 9697906 - view on LGTM.com

new alerts:

1 for Syntax error

fixed alerts:

1 for Clear-text logging of sensitive information

mcdonnnj

I think this second pass catches any last little bits I had in mind.

README.md

src/mdyml/__init__.py

src/mdyml/convert_cisagov.py

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Only calling len(in_row_list) once is better than calling it twice. Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

lgtm-com · 2021-12-30T16:23:19Z

This pull request introduces 1 alert and fixes 1 when merging c118e7e into 9697906 - view on LGTM.com

new alerts:

1 for Syntax error

fixed alerts:

1 for Clear-text logging of sensitive information

felddy and others added 30 commits December 16, 2021 15:56

Add first version of conversion script

82953f6

- rename a bunch of example identifiers - remove uneeded files

Fix bug which caused first table to be skipped

83e2f27

Add pyyaml requirement to setup.py

f439231

Remove noop assignment

f281d64

Add dateparser requirement

6f6dfaf

Add convert_cisagov script

eebeb86

Add pytz requirement

af1aca8

Move common regular expresion to module level

fdc698d

Correct docstring

dec862b

Fix parser to handle changes in markdown

a0593c6

Add logic to handle malformed table data

725efb8

Add some missing types libraries

abf4206

Also remove types-setuptools, since it isn't being used.

Add code to munge, normalize, and sort YAML outputs

8370182

Add a console script for the normalizer

99e3e18

Trim whitespace from values

3df8abc

Merge branch 'first-commits' of github.com:cisagov/md-table-to-yml in…

53f1cc3

…to first-commits

Add derived "investigated" field from status field

22fd1b3

Fix crash on unparsable "dates".

c11c06b

Coo coo cachoo!

Correctly dump the combined, normalized, and sorted data as YML

78857e4

Add code to generate the Markdown table from the grand mal YML

dd3ac3d

Fix logic that checks for empty strings

f9e0e7e

Also duplicate that logic in a few other places where it is useful.

Add status field calculation

0e07cb0

Replace pytablewriter with a manual table printer

9f585c8

pytablewriter was creating very wide tables. there was not an easy way to make more condensed tables

Remove duplicate requirements

9a63cd4

I did not read the "note" that told me not to do the thang that I did.

Remove blurb specific to skeleton repos

abcc954

Update description from skeleton boilerplate

bb678b1

Add a section describing the common YML format

0249420

Add missing comma in status value set

af1c3ee

Thanks to @jsf9k for spotting this over my virtual shoulder. Co-authored-by: @jsf9k

Merge branch 'first-commits' of github.com:cisagov/md-table-to-yml in…

238b8dd

…to first-commits

Update the YML description to match the latest proposed format

f2d3137

The new format can support information for multiple log4j-related CVEs.

jsf9k assigned dav3r Dec 29, 2021

mcdonnnj suggested changes Dec 29, 2021

View reviewed changes

dav3r and others added 9 commits December 29, 2021 16:27

Prefer YAML to YML and add a "Work in Progress" note to one script

2e9daab

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Apply suggestions from code review

6c07028

Change return value from Int to None Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Prefer YAML to YML

6ed417d

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Use more accurate verbiage in log messages

45f238d

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Add a helpful explanatory comment for a regex

be808c2

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Replace skeleton keyword with something useful

27c966a

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Change return value from Int to None

d473c3a

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Add "last_updated" key and description to YAML documentation

36cbbe5

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Correct an outdated comment

4e15437

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

dav3r requested a review from mcdonnnj December 29, 2021 21:56

dav3r added 2 commits December 29, 2021 17:00

Merge branch 'first-commits' of github.com:cisagov/log4j-md-yml into …

a510644

…first-commits

Add two additional keywords to setup.py

e48e22d

Use a library level module to control versioning

5e53e83

Since we want to use the same version for all packages in this project it makes sense to define this at the root level instead of pulling in the version from one of the library's packages.

dav3r mentioned this pull request Dec 30, 2021

Revert to using the official isort repo #2

Closed

mcdonnnj approved these changes Dec 30, 2021

View reviewed changes

dav3r and others added 7 commits December 30, 2021 10:59

Improve log message

289c0f2

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Make docstring more accurate

ef1373b

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Make README more accurate

d69b198

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Move comment closer to line it applies to

434d895

Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Optimize code

84225f5

Only calling len(in_row_list) once is better than calling it twice. Co-authored-by: Nick <50747025+mcdonnnj@users.noreply.github.com>

Satisfy isort pre-commit hook

3cbb18b

Bump version from 0.0.1 to 1.0.0

c118e7e

dav3r merged commit 13c6014 into develop Dec 30, 2021

dav3r deleted the first-commits branch December 30, 2021 16:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial commits #1

Initial commits #1

jsf9k commented Dec 28, 2021 •

edited by dav3r

mcdonnnj left a comment

lgtm-com bot commented Dec 29, 2021

lgtm-com bot commented Dec 29, 2021

lgtm-com bot commented Dec 29, 2021

mcdonnnj left a comment

lgtm-com bot commented Dec 30, 2021

Initial commits #1

Initial commits #1

Conversation

jsf9k commented Dec 28, 2021 • edited by dav3r

🗣 Description

💭 Motivation and context

🧪 Testing

✅ Pre-approval checklist

✅ Pre-merge checklist

✅ Post-merge checklist

mcdonnnj left a comment

Choose a reason for hiding this comment

lgtm-com bot commented Dec 29, 2021

lgtm-com bot commented Dec 29, 2021

lgtm-com bot commented Dec 29, 2021

mcdonnnj left a comment

Choose a reason for hiding this comment

lgtm-com bot commented Dec 30, 2021

jsf9k commented Dec 28, 2021 •

edited by dav3r