Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jonathan Howard <jonathan.w.howard@lmco.com>
- Loading branch information
1 parent
db188d0
commit 74e5efc
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| // -------------------------------------------------------------- | ||
| // SPDX-FileCopyrightText: Copyright © 2024 The Protobom Authors | ||
| // SPDX-FileType: SOURCE | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // -------------------------------------------------------------- | ||
| package ent | ||
|
|
||
| import ( | ||
| "github.com/bom-squad/protobom/pkg/sbom" | ||
|
|
||
| "github.com/protobom/storage/pkg/options" | ||
| ) | ||
|
|
||
| // Retrieve implements the model.v1.storage.Backend interface | ||
| func (EntBackend) Retrieve(string, *options.RetrieveOptions) (*sbom.Document, error) { | ||
| return nil, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,246 @@ | ||
| // -------------------------------------------------------------- | ||
| // SPDX-FileCopyrightText: Copyright © 2024 The Protobom Authors | ||
| // SPDX-FileType: SOURCE | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // -------------------------------------------------------------- | ||
| package ent | ||
|
|
||
| import ( | ||
| "context" | ||
| "database/sql" | ||
| "errors" | ||
| "fmt" | ||
| "slices" | ||
|
|
||
| "github.com/bom-squad/protobom/pkg/sbom" | ||
| sqlite "github.com/glebarez/go-sqlite" | ||
|
|
||
| "github.com/protobom/storage/internal/backends/ent" | ||
| "github.com/protobom/storage/internal/backends/ent/documenttype" | ||
| ent_node "github.com/protobom/storage/internal/backends/ent/node" | ||
| "github.com/protobom/storage/pkg/options" | ||
| ) | ||
|
|
||
| // Enable SQLite foreign key support. | ||
| const dsnParams string = "?_pragma=foreign_keys(1)" | ||
|
|
||
| type ( | ||
| // EntBackend implements the protobom model.v1.storage.Backend interface. | ||
| EntBackend struct{} | ||
|
|
||
| // EntOptions contains options specific to the protobom ent backend. | ||
| EntOptions struct { | ||
| DatabaseFile string | ||
| } | ||
| ) | ||
|
|
||
| var errInvalidEntOptions = errors.New("invalid ent backend options") | ||
|
|
||
| // NewEntOptions returns an EntOptions with optional file path for database file. | ||
| // | ||
| // If not provided, the database file will default to ":memory:" for a temporary, in-memory database. | ||
| func NewEntOptions(file string) EntOptions { | ||
| if file == "" { | ||
| file = ":memory:" | ||
| } | ||
|
|
||
| return EntOptions{DatabaseFile: file} | ||
| } | ||
|
|
||
| // Store implements the model.v1.storage.Backend interface | ||
| func (EntBackend) Store(bom *sbom.Document, opts *options.StoreOptions) error { | ||
| var err error | ||
|
|
||
| if opts == nil { | ||
| opts = &options.StoreOptions{} | ||
| } | ||
|
|
||
| if opts.BackendOptions == nil { | ||
| opts.BackendOptions = NewEntOptions("") | ||
| } | ||
|
|
||
| entOpts, ok := opts.BackendOptions.(EntOptions) | ||
| if !ok { | ||
| return fmt.Errorf("%w: %v", errInvalidEntOptions, opts.BackendOptions) | ||
| } | ||
|
|
||
| // Register the SQLite driver as "sqlite3". | ||
| if !slices.Contains(sql.Drivers(), "sqlite3") { | ||
| sqlite.RegisterAsSQLITE3() | ||
| } | ||
|
|
||
| client, err := ent.Open("sqlite3", fmt.Sprintf("%s%s", entOpts.DatabaseFile, dsnParams)) | ||
| if err != nil { | ||
| return fmt.Errorf("failed opening connection to sqlite: %w", err) | ||
| } | ||
|
|
||
| defer client.Close() | ||
|
|
||
| tx, err := client.Tx(context.Background()) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create transactional client: %w", err) | ||
| } | ||
|
|
||
| ctx := ent.NewTxContext(context.Background(), tx) | ||
|
|
||
| // Run the auto migration tool. | ||
| if err := client.Schema.Create(ctx); err != nil { | ||
| return fmt.Errorf("failed creating schema resources: %w", err) | ||
| } | ||
|
|
||
| documentCreate := tx.Document.Create(). | ||
| SetMetadata(metadataToEnt(ctx, tx, bom.Metadata)). | ||
| SetNodeList(nodeListToEnt(ctx, tx, bom.NodeList)) | ||
|
|
||
| _, err = documentCreate.Save(ctx) | ||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| return fmt.Errorf("failed to save document: %w", err) | ||
| } | ||
|
|
||
| if err := tx.Commit(); err != nil { | ||
| return fmt.Errorf("failed to commit database transaction: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func documentTypesToEnt(ctx context.Context, tx *ent.Tx, docTypes []*sbom.DocumentType) ent.DocumentTypes { | ||
| entDocTypes := ent.DocumentTypes{} | ||
|
|
||
| for _, docType := range docTypes { | ||
| typeName := documenttype.Type(*docType.Type) | ||
| docTypeCreate := tx.DocumentType.Create(). | ||
| SetNillableName(docType.Name). | ||
| SetNillableDescription(docType.Description). | ||
| SetNillableType(&typeName) | ||
|
|
||
| entDocType, err := docTypeCreate.Save(ctx) | ||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| panic(err) | ||
| } | ||
|
|
||
| entDocTypes = append(entDocTypes, entDocType) | ||
| } | ||
|
|
||
| return entDocTypes | ||
| } | ||
|
|
||
| func metadataToEnt(ctx context.Context, tx *ent.Tx, md *sbom.Metadata) *ent.Metadata { | ||
| metadataCreate := tx.Metadata.Create(). | ||
| SetID(md.Id). | ||
| SetVersion(md.Version). | ||
| SetName(md.Name). | ||
| SetDate(md.Date.AsTime()). | ||
| SetComment(md.Comment) | ||
|
|
||
| metadata, err := metadataCreate. | ||
| AddAuthors(personsToEnt(ctx, tx, md.Authors)...). | ||
| AddDocumentTypes(documentTypesToEnt(ctx, tx, md.DocumentTypes)...). | ||
| AddTools(toolsToEnt(ctx, tx, md.Tools)...). | ||
| Save(ctx) | ||
|
|
||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| panic(err) | ||
| } | ||
|
|
||
| return metadata | ||
| } | ||
|
|
||
| func nodeListToEnt(ctx context.Context, tx *ent.Tx, nodeList *sbom.NodeList) *ent.NodeList { | ||
| nodeListCreate := tx.NodeList.Create().SetRootElements(nodeList.RootElements) | ||
|
|
||
| entNodeList, err := nodeListCreate.AddNodes(nodesToEnt(ctx, tx, nodeList.Nodes)...).Save(ctx) | ||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| panic(err) | ||
| } | ||
|
|
||
| return entNodeList | ||
| } | ||
|
|
||
| func nodesToEnt(ctx context.Context, tx *ent.Tx, nodes []*sbom.Node) ent.Nodes { | ||
| var entNodes ent.Nodes | ||
| for _, node := range nodes { | ||
| nodeCreate := tx.Node.Create(). | ||
| SetID(node.Id). | ||
| SetAttribution(node.Attribution). | ||
| SetBuildDate(node.BuildDate.AsTime()). | ||
| SetComment(node.Comment). | ||
| SetCopyright(node.Copyright). | ||
| SetDescription(node.Description). | ||
| SetFileName(node.FileName). | ||
| SetFileTypes(node.FileTypes). | ||
| SetLicenseComments(node.LicenseComments). | ||
| SetLicenseConcluded(node.LicenseConcluded). | ||
| SetLicenses(node.Licenses). | ||
| SetName(node.Name). | ||
| SetReleaseDate(node.ReleaseDate.AsTime()). | ||
| SetSourceInfo(node.SourceInfo). | ||
| SetSummary(node.Summary). | ||
| SetType(ent_node.Type(node.Type.String())). | ||
| SetURLDownload(node.UrlDownload). | ||
| SetURLHome(node.UrlHome). | ||
| SetValidUntilDate(node.ValidUntilDate.AsTime()). | ||
| SetVersion(node.Version) | ||
|
|
||
| nodeCreate. | ||
| AddEdgeTypes(). | ||
| AddExternalReferences(). | ||
| AddHashes(). | ||
| AddIdentifiers(). | ||
| AddNodes(). | ||
| AddOriginators(). | ||
| AddPrimaryPurpose(). | ||
| AddSuppliers() | ||
|
|
||
| entNode, err := nodeCreate.Save(ctx) | ||
|
|
||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| panic(err) | ||
| } | ||
|
|
||
| entNodes = append(entNodes, entNode) | ||
| } | ||
|
|
||
| return entNodes | ||
| } | ||
|
|
||
| func personsToEnt(ctx context.Context, tx *ent.Tx, persons []*sbom.Person) ent.Persons { | ||
| var entPersons ent.Persons | ||
| for _, person := range persons { | ||
| entPerson, err := tx.Person.Create(). | ||
| SetName(person.Name). | ||
| SetEmail(person.Email). | ||
| SetIsOrg(person.IsOrg). | ||
| SetPhone(person.Phone). | ||
| SetURL(person.Url). | ||
| AddContacts(personsToEnt(ctx, tx, person.Contacts)...). | ||
| Save(ctx) | ||
|
|
||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| panic(err) | ||
| } | ||
|
|
||
| entPersons = append(entPersons, entPerson) | ||
| } | ||
|
|
||
| return entPersons | ||
| } | ||
|
|
||
| func toolsToEnt(ctx context.Context, tx *ent.Tx, tools []*sbom.Tool) ent.Tools { | ||
| var entTools ent.Tools | ||
| for _, tool := range tools { | ||
| entTool, err := tx.Tool.Create(). | ||
| SetName(tool.Name). | ||
| SetVendor(tool.Vendor). | ||
| SetVersion(tool.Version). | ||
| Save(ctx) | ||
|
|
||
| if err != nil && errors.Is(err, sql.ErrNoRows) { | ||
| panic(err) | ||
| } | ||
|
|
||
| entTools = append(entTools, entTool) | ||
| } | ||
|
|
||
| return entTools | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters