feat: 295 monorepo directory structure design proposal #389

gvauter · 2024-11-20T16:39:00Z

Description

This PR contains the initial code for a Click based CLI for trestle-bot as described in ADR-001. This Click based CLI will replace the existing entrypoints modules. This PR only contains the code for the CLI, it does not break any existing commands/actions. Subsequent PRs will make the necessary changes to swap the current entrypoints with these new CLI commands.

Fixes # #295

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

How has this been tested?

Unit tests have been added in tests/cli for all new CLI commands/modules.

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
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Bumps [compliance-trestle](https://github.com/oscal-compass/compliance-trestle) from 3.4.0 to 3.5.0. - [Release notes](https://github.com/oscal-compass/compliance-trestle/releases) - [Changelog](https://github.com/oscal-compass/compliance-trestle/blob/develop/CHANGELOG.md) - [Commits](oscal-compass/compliance-trestle@v3.4.0...v3.5.0) --- updated-dependencies: - dependency-name: compliance-trestle dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…l values. improves config error handling.

…init

…id configs

gvauter

Some initial comments.

trestlebot/cli/base.py

trestlebot/cli/commands/create.py

trestlebot/cli/commands/init.py

trestlebot/cli/root.py

…thub.com:RedHatProductSecurity/trestle-bot into 295-monorepo-directory-structure-design-proposal

I noted there are some missing options in create command.

trestlebot/cli/commands/create.py

huiwangredhat · 2024-12-13T06:07:08Z

tests/trestlebot/cli/test_create_cmd.py

+            tmp_init_dir,
+        ],
+    )
+    assert result.exit_code == 2


The expected exit_code is 2? Is there any context I missed?

I think the arguments, '--committer-email', '--committer-name' and '--branch'could be added; repo-path could be updated to --repo-path; theassert result.exit_code == 2could beresult.exit_code == 0 `.

@huiwangredhat yes, you are correct, this should have a successful exit code since test expects it work correctly.

marcusburghardt

Only one typo and other two minor empty lines. I didn't check all transformations but only the CLI changes.

marcusburghardt · 2024-12-17T07:45:55Z

trestlebot/cli/options/common.py

+    If the user specifies a value for the option directly (e.g. uses --option value)
+    then that value is used in favor of the value loaded from the config.
+
+    Simarly, if an option has an associated ENVVAR, and that ENVVAR is set, then the


Suggested change

Simarly, if an option has an associated ENVVAR, and that ENVVAR is set, then the

Similarly, if an option has an associated ENVVAR, and that ENVVAR is set, then the

marcusburghardt · 2024-12-17T08:27:18Z

trestlebot/cli/log.py

@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2023 Red Hat, Inc.
+


Suggested change

marcusburghardt · 2024-12-17T08:29:48Z

trestlebot/cli/root.py

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) 2024 Red Hat, Inc.
+


Suggested change

marcusburghardt · 2024-12-17T08:50:59Z

trestlebot/cli/commands/sync_upstreams.py

+    help="Comma-separated list of upstream git sources to sync. Each source is a string \
+                in the form <repo_url>@<ref> where ref is a git ref such as a tag or branch.",


Suggested change

help="Comma-separated list of upstream git sources to sync. Each source is a string \

in the form <repo_url>@<ref> where ref is a git ref such as a tag or branch.",

help="Comma-separated list of upstream git sources to sync. Each source is a string \

in the form <repo_url>@<ref> where ref is a git ref such as a tag or branch.",

Signed-off-by: George Vauter <gvauter@redhat.com>

huiwangredhat

LGTM. Thanks for updating.

marcusburghardt

Nice work. I think this new CLI improved considerably the experience. Thanks.

…thub.com:RedHatProductSecurity/trestle-bot into 295-monorepo-directory-structure-design-proposal

hbraswelrh and others added 11 commits November 12, 2024 14:44

initial directory structure organization

01fea64

feat: initial work on config and common options

ec67718

chore: add openssf scorecard workflow (#359)

a1984a5

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

feat: adds logic to load yaml config into click context to set defaut…

c5b9418

…l values. improves config error handling.

feat: adds debug logging statements

c6a2569

feat: add markdown directory creation and call to compliance trestle …

78fd113

…init

feat: simplify directory creation and better error handling for inval…

6be37e8

…id configs

feat: initial work on autosync

45fc4b8

Initial create command for click cli

a239482

Initial create command for click cli

5931b5c

gvauter linked an issue Nov 20, 2024 that may be closed by this pull request

“Monorepo” Directory Structure Design Proposal #295

Closed

gvauter commented Nov 20, 2024

View reviewed changes

trestlebot/cli/base.py Outdated Show resolved Hide resolved

trestlebot/cli/base.py Outdated Show resolved Hide resolved

trestlebot/cli/commands/create.py Outdated Show resolved Hide resolved

trestlebot/cli/commands/create.py Outdated Show resolved Hide resolved

gvauter added 2 commits November 20, 2024 12:51

adding unit test for config module

1ba1010

adding unit test for config module

7645fbe

hbraswelrh reviewed Nov 20, 2024

View reviewed changes

trestlebot/cli/commands/init.py Outdated Show resolved Hide resolved

hbraswelrh reviewed Nov 20, 2024

View reviewed changes

trestlebot/cli/root.py Show resolved Hide resolved

hbraswelrh reviewed Nov 20, 2024

View reviewed changes

trestlebot/cli/root.py Show resolved Hide resolved

qduanmu force-pushed the 295-monorepo-directory-structure-design-proposal branch from 23ac47d to 0237e3b Compare November 21, 2024 07:39

qduanmu added 2 commits November 21, 2024 15:45

Update autosync command

268c558

Update autosync command

823e5bc

qduanmu force-pushed the 295-monorepo-directory-structure-design-proposal branch from 0237e3b to 823e5bc Compare November 21, 2024 07:46

gvauter and others added 8 commits November 21, 2024 08:48

feat: add ssp index option

000e26e

feat: add ssp index option

5aeb27d

add unit tests for init command

362faf1

add unit tests for init command

75fd0c1

Merge branch '295-monorepo-directory-structure-design-proposal' of gi…

59da2c8

…thub.com:RedHatProductSecurity/trestle-bot into 295-monorepo-directory-structure-design-proposal

Merge branch '295-monorepo-directory-structure-design-proposal' of gi…

7f266f0

…thub.com:RedHatProductSecurity/trestle-bot into 295-monorepo-directory-structure-design-proposal

feat: root call create and logging replacement

1382cdc

feat: root call create and logging replacement

3292aa5

hbraswelrh added 2 commits December 11, 2024 09:21

fix: default value returned if no key in dictionary

7711aec

fix: default value returned if no key in dictionary

b3b8ebd

qduanmu previously approved these changes Dec 13, 2024

View reviewed changes

qduanmu reviewed Dec 13, 2024

View reviewed changes

trestlebot/cli/commands/create.py Show resolved Hide resolved

huiwangredhat reviewed Dec 13, 2024

View reviewed changes

qduanmu added 4 commits December 13, 2024 15:58

feat: align skip-item option to skip-items

826a8f5

feat: align skip-item option to skip-items

5144e10

fix: add missing git options in create command

84c38ba

fix: add missing git options in create command

06e574b

marcusburghardt reviewed Dec 17, 2024

View reviewed changes

gvauter added 12 commits December 17, 2024 11:12

fix: refactor testt and remove prompts

ddff735

fix: refactor testt and remove prompts

6e28c41

fix: formatting issues and typos

e47dca5

fix: formatting issues and typos

f125d5f

chore: merge latest from main and fix conflicts

fd2f738

Signed-off-by: George Vauter <gvauter@redhat.com>

chore: merge latest from main and fix conflicts

3b95d76

Signed-off-by: George Vauter <gvauter@redhat.com>

chore: update poetry lock with latest dependencies

954d38a

Signed-off-by: George Vauter <gvauter@redhat.com>

chore: update poetry lock with latest dependencies

586bfca

Signed-off-by: George Vauter <gvauter@redhat.com>

fix: do not overwrite config path if set

1f6f6c6

Signed-off-by: George Vauter <gvauter@redhat.com>

fix: do not overwrite config path if set

ceb084c

Signed-off-by: George Vauter <gvauter@redhat.com>

fix: do not overwrite config path if set

769d0df

Signed-off-by: George Vauter <gvauter@redhat.com>

fix: do not overwrite config path if set

18eaf09

Signed-off-by: George Vauter <gvauter@redhat.com>

huiwangredhat approved these changes Dec 18, 2024

View reviewed changes

qduanmu force-pushed the 295-monorepo-directory-structure-design-proposal branch from 18eaf09 to 769d0df Compare December 18, 2024 03:55

marcusburghardt approved these changes Dec 18, 2024

View reviewed changes

Merge branch '295-monorepo-directory-structure-design-proposal' of gi…

32a4132

…thub.com:RedHatProductSecurity/trestle-bot into 295-monorepo-directory-structure-design-proposal

gvauter merged commit 0314389 into main Dec 18, 2024
13 checks passed

github-actions bot mentioned this pull request Nov 26, 2024

chore(main): release 0.12.0 #351

Open

hbraswelrh mentioned this pull request Dec 20, 2024

fix: update create command for e2e testing #399

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 295 monorepo directory structure design proposal #389

feat: 295 monorepo directory structure design proposal #389

gvauter commented Nov 20, 2024 •

edited

Loading

gvauter left a comment

huiwangredhat Dec 13, 2024

huiwangredhat Dec 17, 2024 •

edited

Loading

gvauter Dec 17, 2024

marcusburghardt left a comment

marcusburghardt Dec 17, 2024

marcusburghardt Dec 17, 2024

marcusburghardt Dec 17, 2024

marcusburghardt Dec 17, 2024

huiwangredhat left a comment

marcusburghardt left a comment

	Simarly, if an option has an associated ENVVAR, and that ENVVAR is set, then the
	Similarly, if an option has an associated ENVVAR, and that ENVVAR is set, then the

		@@ -0,0 +1,59 @@
		# SPDX-License-Identifier: Apache-2.0
		# Copyright (c) 2023 Red Hat, Inc.

		@@ -0,0 +1,36 @@
		# SPDX-License-Identifier: Apache-2.0
		# Copyright (c) 2024 Red Hat, Inc.

		help="Comma-separated list of upstream git sources to sync. Each source is a string \
		in the form <repo_url>@<ref> where ref is a git ref such as a tag or branch.",

feat: 295 monorepo directory structure design proposal #389

feat: 295 monorepo directory structure design proposal #389

Conversation

gvauter commented Nov 20, 2024 • edited Loading

Description

Type of change

How has this been tested?

Checklist

gvauter left a comment

Choose a reason for hiding this comment

huiwangredhat Dec 13, 2024

Choose a reason for hiding this comment

huiwangredhat Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

gvauter Dec 17, 2024

Choose a reason for hiding this comment

marcusburghardt left a comment

Choose a reason for hiding this comment

marcusburghardt Dec 17, 2024

Choose a reason for hiding this comment

marcusburghardt Dec 17, 2024

Choose a reason for hiding this comment

marcusburghardt Dec 17, 2024

Choose a reason for hiding this comment

marcusburghardt Dec 17, 2024

Choose a reason for hiding this comment

huiwangredhat left a comment

Choose a reason for hiding this comment

marcusburghardt left a comment

Choose a reason for hiding this comment

gvauter commented Nov 20, 2024 •

edited

Loading

huiwangredhat Dec 17, 2024 •

edited

Loading