Skip to content

Commit

Permalink
feat: Implement plugin system for archivists' parsers
Browse files Browse the repository at this point in the history
This commit introduces a flexible plugin system for archivists' parsers,
allowing new parsers to be registered dynamically. The system utilizes an
initialization function that registers parsers via a `Register` function. The
primary changes include:

- Creation of `parser_registry.go` to handle parser registration and storage.
- Modification of `parserstorer.go` to integrate the new parser registration
  system and utilize registered parsers during attestation storage.

This system enhances the extensibility of the parser functionality and improves
maintainability by decoupling the parser registration from the core logic.

Changes:
- Added `internal/metadatastorage/attestationcollection/parser_registry.go` for
  parser registration.
- Updated `internal/metadatastorage/attestationcollection/parserstorer.go` to
  support the new plugin system.

Signed-off-by: Frederick F. Kautz IV <[email protected]>
  • Loading branch information
fkautz committed Jun 5, 2024
1 parent 2eab116 commit f6fdc33
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 3 deletions.
35 changes: 35 additions & 0 deletions pkg/metadatastorage/attestationcollection/parser_registry.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Copyright 2024 The Archivista Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package attestationcollection

import (
"context"
"encoding/json"
"github.com/in-toto/archivista/ent"
"log"
)

var registeredParsers map[string]AttestationParser

func init() {
registeredParsers = make(map[string]AttestationParser)
}

func Register(attestationType string, parser AttestationParser) {
registeredParsers[attestationType] = parser
log.Printf("parser registered: %s", attestationType)

Check warning on line 32 in pkg/metadatastorage/attestationcollection/parser_registry.go

View check run for this annotation

Codecov / codecov/patch

pkg/metadatastorage/attestationcollection/parser_registry.go#L30-L32

Added lines #L30 - L32 were not covered by tests
}

type AttestationParser func(ctx context.Context, tx *ent.Tx, attestation *ent.Attestation, attestationType string, message json.RawMessage) error
16 changes: 13 additions & 3 deletions pkg/metadatastorage/attestationcollection/parserstorer.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ package attestationcollection
import (
"context"
"encoding/json"

"github.com/google/uuid"
"github.com/in-toto/archivista/ent"
"github.com/in-toto/archivista/pkg/metadatastorage"
"github.com/in-toto/go-witness/attestation"
"github.com/in-toto/go-witness/log"
)

const (
Expand Down Expand Up @@ -58,12 +58,22 @@ func (parsedCollection ParsedCollection) Store(ctx context.Context, tx *ent.Tx,
}

for _, a := range parsedCollection.Attestations {
if err := tx.Attestation.Create().
newAttestation, err := tx.Attestation.Create().

Check warning on line 61 in pkg/metadatastorage/attestationcollection/parserstorer.go

View check run for this annotation

Codecov / codecov/patch

pkg/metadatastorage/attestationcollection/parserstorer.go#L61

Added line #L61 was not covered by tests
SetAttestationCollectionID(collection.ID).
SetType(a.Type).
Exec(ctx); err != nil {
Save(ctx)
if err != nil {

Check warning on line 65 in pkg/metadatastorage/attestationcollection/parserstorer.go

View check run for this annotation

Codecov / codecov/patch

pkg/metadatastorage/attestationcollection/parserstorer.go#L64-L65

Added lines #L64 - L65 were not covered by tests
return err
}

if parser, exists := registeredParsers[a.Type]; exists {
if err := parser(ctx, tx, newAttestation, a.Type, a.Attestation); err != nil {
log.Errorf("failed to parse attestation of type %s: %w", a.Type, err)
return err

Check warning on line 72 in pkg/metadatastorage/attestationcollection/parserstorer.go

View check run for this annotation

Codecov / codecov/patch

pkg/metadatastorage/attestationcollection/parserstorer.go#L69-L72

Added lines #L69 - L72 were not covered by tests
}
} else {

Check failure on line 74 in pkg/metadatastorage/attestationcollection/parserstorer.go

View workflow job for this annotation

GitHub Actions / lint

SA9003: empty branch (staticcheck)

Check warning on line 74 in pkg/metadatastorage/attestationcollection/parserstorer.go

View check run for this annotation

Codecov / codecov/patch

pkg/metadatastorage/attestationcollection/parserstorer.go#L74

Added line #L74 was not covered by tests
// parser doesn't exist, so just ignore and proceed
}
}

return nil
Expand Down

0 comments on commit f6fdc33

Please sign in to comment.