pkg/metadata: bundle metadata utils and types#60
pkg/metadata: bundle metadata utils and types#60estroz wants to merge 3 commits intooperator-framework:masterfrom
Conversation
openshift-ci-robot
added
the
kind/feature
… in a directory and its children
estroz
force-pushed
the
feature/find-metadata
branch
from
262762c to
8b174fd
Compare
|
Relevant to this PR: because we're adding this function to the api lib, can we consider adding the bundle spec itself to this lib, specifically labels and some convenient access methods for them? |
| // readAnnotations reads annotations from file(s) in bundleRoot and returns them as a map. | ||
| func readAnnotations(fs afero.Fs, annotationsPath string) (map[string]string, error) { | ||
| // The annotations file is well-defined. | ||
| b, err := afero.ReadFile(fs, annotationsPath) |
There was a problem hiding this comment.
Why not just use ioutil instead of adding an external dependency?
There was a problem hiding this comment.
It's much easier to test with afero since we don't have to write testdata to disk for each new case. Plus there's a Go design draft for a std file system interface, which we could replace this with in the future.
|
|
||
| // Use the arbitrarily-indexed representation of the annotations file for forwards and backwards compatibility. | ||
| annotations := struct { | ||
| Annotations map[string]string `json:"annotations"` |
There was a problem hiding this comment.
Why don't we use a more versioned structured type here? Just so that additional arbitrary annotations can be added? It seems like either way we need to validate that it has the set of required annotations to make the bundle work, so maybe that should be included here?
There was a problem hiding this comment.
Exactly, so arbitrary annotations can be added. There may be a way to load both versioned and arbitrary annotations into some struct type, which I can experiment with in this PR, but I wasn't sure about doing that initially (see #60 (comment)).
and return the full AnnotationsFile from FindAnnotations() pkg/manifests: move metadata types to pkg/metadata
| "strings" | ||
|
|
||
| log "github.com/sirupsen/logrus" | ||
| "github.com/spf13/afero" |
estroz
changed the title
annotations.yaml search utility function FindAnnotations()
openshift-ci-robot
added
the
needs-rebase
|
@estroz: PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
Is this still alive? I could sure use it. I'd be happy to rebase it and get it updated. |
Sure. Go ahead. |
|
closing as stale |
7 participants
There should be a canonical set of utilities and types that can find and parse an
annotations.yamlin a bundle directory instead of re-implementing that logic in various ways in various operator-framework repos. This repo is a good home for them because it is the source of truth for many OF APIs./cc @kevinrizza @dinhxuanvu
/kind feature