datasource.go

//
// Copyright 2023 The GUAC Authors.
//
// 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 datasource

import "context"

// CollectSource provides a way for collector to get collect targets from
// a data source (e.g. a file, a database, a pubsub queue, etc.)
//
// This provides the flexibility for collectors to be configured in a
// similar way to prevent configuration drift among collectors, and
// provide a way to centrally manage collector source targets.
type CollectSource interface {
	// GetDataSources returns a data source containing targets for the
	// collector to collect
	GetDataSources(ctx context.Context) (*DataSources, error)

	// DataSourcesUpdate will return a channel which will get an element
	// if the CollectSource has new data. This is heuristical and the
	// channel may get an eleemnt even if there is no new data.
	DataSourcesUpdate(ctx context.Context) (<-chan error, error)
}

type DataSources struct {
	OciDataSources []Source
	// NOTE: Git data sources should follow the URI scheme as defined in:
	// https://spdx.github.io/spdx-spec/v2.3/package-information/#771-description
	// <vcs_tool>+<transport>://<host_name>[/<path_to_repository>][@<revision_tag_or_branch>][#<sub_path>]
	// e.g. git+https://github.com/guacsec/guac@v1
	GitDataSources []Source
	// NOTE: It is expected that a GithubReleaseDataSource is of the form:
	// https://github.com/<org>/<repo>/releases/<tag> or
	// https://github.com/<org>/<repo>/releases/tag/<tag> or
	// https://github.com/<org>/<repo>/releases
	// Tag is optional and left off will assume latest.
	GithubReleaseDataSources []Source
	// PurlDataSources encodes the list of PURLs
	PurlDataSources []Source
}

type Source struct {
	Value string
}