Runner package and generator object skeletons #294

puerco · 2023-07-21T21:07:38Z

This PR adds the skeleton of a mockable runner package.

The package has a generator object that executes all the SBOM generation
logic. It relies on two underlying objects: the implementation and the
document format handler.

The implementation handles all the generator main functions.
All the format-specific code lies in thG format handler which can be
swapped out for each format supported by the generator.

This is a skeleton only, the logic needs to be implemented still.

/cc @nishakm @ba11b0y

Signed-off-by: Adolfo García Veytia (Puerco) puerco@chainguard.dev

This commit adds the skeleton of a mockable runner package. The package has a generator object that executes all the SBOM generation logic. It relies on two underlying objects: the implementation and the document format handler. - The implementation handles all the generator main functions. - All the format-specific code lies in the format handler which can be swapped out for each format supported by the generator. This is a skeleton only, the logic needs to be implemented still. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco

@ba11boy:

Here is the skeleton to plug the parser functionality and redraw the flow of the generator.

At its core, the CLI would simply create a new runner.Generator() and create the sbom:

// Create a new generator
generator := runner.NewWithOptions(options.Options{})

// Write the SBOM to STDOOUT:
generator.CreateSBOM("path/to/source", os.Stdout)

I've added some comments hinting where to plug the logic you wrote in #293

Once we have a working prototype we can generate the mocks and write integration tests.

Let me know if you have any questions!

puerco · 2023-07-21T21:09:14Z

pkg/runner/implementation.go

+	}
+}
+
+func (di *defaultGeneratorImplementation) GetCodeParsers(*options.Options) ([]plugin.Plugin, error) {


@ba11b0y this function should capture this part:

https://github.com/opensbom-generator/spdx-sbom-generator/pull/293/files#diff-b1b1ceed0867564530b26682e0ec1ed2d5727b7778ad1c201d43b8ba0b75196aR70-R82

puerco · 2023-07-21T21:10:52Z

pkg/runner/implementation.go

+	return nil, nil
+}
+
+func (di *defaultGeneratorImplementation) RunParser(*options.Options, plugin.Plugin) ([]meta.Package, error) {


@ba11b0y here we execute the language parsers, like in your PR here

https://github.com/opensbom-generator/spdx-sbom-generator/pull/293/files#diff-b1b1ceed0867564530b26682e0ec1ed2d5727b7778ad1c201d43b8ba0b75196aR89

puerco · 2023-07-21T21:13:02Z

pkg/runner/dochandlers/v23/v23.go

+	// TODO: Create the new SPDX packages
+	// TODO: Assign the meta package data
+	// TODO: Add to document
+	// TODO: Relate the package to the top level directory


@ba11b0y:
This function captures the main conversion of metapackage to spdx 2.3 package. It should implement each step, including your convertToPackage() function in your original PR.

puerco · 2023-07-21T21:14:18Z

pkg/runner/dochandlers/v23/v23.go

+	// TODO: Create top-level package
+	// TODO: Relate top-level package to document


@ba11b0y:

Thew SPDX document needs to have a top-level package representing the source code base. All the packages coming from the parsers should be related to that top-level element (not directly to the document).

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

pkg/runner/options/options.go

pkg/runner/generator.go

nishakm · 2023-07-21T22:03:50Z

pkg/runner/generator.go

+
+type DocumentFormatHandler interface {
+	CreateDocument(*options.Options) (interface{}, error)
+	AddDocumentPackages(*options.Options, interface{}, []meta.Package) error


Why not combine these together? I remember you had a reason, but I can't recall what it was.

I split them in preparation for a more complete generation process. If we add more steps, for example splitting the licensing bits or registering files, then it is easier to move the stages around.

Since it is is internal, we can combine them now and split them later if we need it.

Based on conversations we've been having in the SBOM community (I'm thinking about our current issue with CreationInfo) it seems to me we will probably want to generate a document with its elements all in one go. In which case, maybe the underlying functionality (make each element one by one and assemble them into a document) maybe makes more sense?

ba11b0y

Should I then create a new PR off of this or make changes in this PR itself?

ba11b0y · 2023-07-22T14:34:38Z

pkg/runner/generator.go

+	g.docHandler = newDocHandler
+
+	// Check the codebase and return the applicable parsers
+	parsers, err := g.implementation.GetCodeParsers(&g.Options)


I can't think of a case where there would be more than 1 applicable parsers, care to explain?

Multiple languages used in one project maybe?

ba11b0y · 2023-07-23T10:23:40Z

go.mod

@@ -2,49 +2,58 @@

 module github.com/spdx/spdx-sbom-generator

-go 1.17
+go 1.20


nishakm · 2023-07-24T12:51:37Z

Should I then create a new PR off of this or make changes in this PR itself?

Sure if it's easier for you.

puerco added 2 commits July 21, 2023 15:01

go.mod: Bump to go 1.20

cdc004a

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco requested a review from nishakm July 21, 2023 21:07

puerco commented Jul 21, 2023

View reviewed changes

puerco added the GSoC-2023 label Jul 21, 2023

Drop SBOM Generation in Presubmit

4b2ec8f

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

nishakm reviewed Jul 21, 2023

View reviewed changes

pkg/runner/options/options.go Show resolved Hide resolved

nishakm reviewed Jul 21, 2023

View reviewed changes

pkg/runner/generator.go Show resolved Hide resolved

nishakm reviewed Jul 21, 2023

View reviewed changes

ba11b0y reviewed Jul 22, 2023

View reviewed changes

ba11b0y reviewed Jul 23, 2023

View reviewed changes

go.mod

@@ -2,49 +2,58 @@

module github.com/spdx/spdx-sbom-generator

go 1.17

go 1.20

Copy link

Contributor

ba11b0y Jul 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

nishakm merged commit 4b2ec8f into opensbom-generator:main Aug 11, 2023
1 check passed

nishakm mentioned this pull request Sep 20, 2023

Refactor: Change Plugin Architecture #306

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Runner package and generator object skeletons #294

Runner package and generator object skeletons #294

puerco commented Jul 21, 2023

puerco left a comment

puerco Jul 21, 2023

puerco Jul 21, 2023

puerco Jul 21, 2023

puerco Jul 21, 2023

nishakm Jul 21, 2023

puerco Jul 22, 2023

nishakm Jul 24, 2023

ba11b0y left a comment •

edited

Loading

ba11b0y Jul 22, 2023

nishakm Jul 24, 2023

ba11b0y Jul 24, 2023

ba11b0y Jul 23, 2023

nishakm commented Jul 24, 2023

		// TODO: Create top-level package
		// TODO: Relate top-level package to document

Runner package and generator object skeletons #294

Runner package and generator object skeletons #294

Conversation

puerco commented Jul 21, 2023

puerco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ba11b0y left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nishakm commented Jul 24, 2023

ba11b0y left a comment •

edited

Loading