99abc1373d
This extends the possible ways of passing references to inputs. The
current ways possible are:
1) "plain references", an array of strings:
["ref1", "ref2", ...]
2) "object references", a mapping of keys to objects:
{"ref1": { <options> }, "ref2": { <options> }, ...}
This patch adds a new way:
3) "array of object references":
[{"id": "ref1", "options": { ... }}, {"id": ... }, ]
While osbuild promises to preserves the order for "object references"
not all JSON serialization libraries preserve the order since the
JSON specification does leave this up to the implementation.
The new "array of object references" thus allows for specifying the
references together with reference specific options and this in a
specific order.
Additionally this paves the way for specifying the same input twice,
e.g. in the case of the `org.osbuild.files` input where a pipeline
could then be specified twice with different files. This needs core
rework though, since internally we use dictionaries right now.
227 lines
5.3 KiB
Python
Executable file
227 lines
5.3 KiB
Python
Executable file
#!/usr/bin/python3
|
|
"""
|
|
Inputs for individual files
|
|
|
|
Provides all the files, named via their content hash, specified
|
|
via `references` in a new directory.
|
|
|
|
The returned data in `files` is a dictionary where the keys are
|
|
paths to the provided files and the values dictionaries with
|
|
metadata for it. The input itself currently does not set any
|
|
metadata itself, but will forward any metadata set via the
|
|
`metadata` property. Keys in that must start with a prefix,
|
|
like `rpm.` to avoid namespace clashes. This is enforced via
|
|
schema validation.
|
|
"""
|
|
|
|
import os
|
|
import pathlib
|
|
import sys
|
|
|
|
from osbuild import inputs
|
|
|
|
|
|
SCHEMA = r"""
|
|
"definitions": {
|
|
"metadata": {
|
|
"description": "Additional metadata to forward to the stage",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"patternProperties": {
|
|
"^\\w+[.]{1}\\w+$": {
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
},
|
|
"file": {
|
|
"description": "File to access with in a pipeline",
|
|
"type": "string"
|
|
},
|
|
"plain-ref": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"source-options": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"metadata": {
|
|
"$ref": "#/definitions/metadata"
|
|
}
|
|
}
|
|
},
|
|
"source-object-ref": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"minProperties": 1,
|
|
"patternProperties": {
|
|
".*": {
|
|
"$ref": "#/definitions/source-options"
|
|
}
|
|
}
|
|
},
|
|
"source-array-ref": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["id"],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"$ref": "#/definitions/source-options"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"source-origin": {
|
|
"type": "string",
|
|
"description": "When the origin of the input is a source",
|
|
"enum": ["org.osbuild.source"]
|
|
},
|
|
"pipeline-options": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"metadata": {
|
|
"$ref": "#/definitions/metadata"
|
|
},
|
|
"file": {
|
|
"$ref": "#/definitions/file"
|
|
}
|
|
}
|
|
},
|
|
"pipeline-object-ref": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"minProperties": 1,
|
|
"patternProperties": {
|
|
".*": {
|
|
"$ref": "#/definitions/pipeline-options"
|
|
}
|
|
}
|
|
},
|
|
"pipeline-array-ref": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": ["id"],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"$ref": "#/definitions/pipeline-options"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"pipeline-origin": {
|
|
"type": "string",
|
|
"description": "When the origin of the input is a pipeline",
|
|
"enum": ["org.osbuild.pipeline"]
|
|
}
|
|
},
|
|
"additionalProperties": true,
|
|
"oneOf": [
|
|
{
|
|
"additionalProperties": false,
|
|
"required": ["type", "origin", "references"],
|
|
"properties": {
|
|
"type": {
|
|
"enum": ["org.osbuild.files"]
|
|
},
|
|
"origin": {
|
|
"description": "The org.osbuild.source origin case",
|
|
"$ref": "#/definitions/source-origin"
|
|
},
|
|
"references": {
|
|
"description": "Checksums of files to use as files input",
|
|
"oneOf": [
|
|
{"$ref": "#/definitions/plain-ref"},
|
|
{"$ref": "#/definitions/source-array-ref"},
|
|
{"$ref": "#/definitions/source-object-ref"}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"required": ["type", "origin", "references"],
|
|
"properties": {
|
|
"type": {
|
|
"enum": ["org.osbuild.files"]
|
|
},
|
|
"origin": {
|
|
"description": "The org.osbuild.pipeline origin case",
|
|
"$ref": "#/definitions/pipeline-origin"
|
|
},
|
|
"references": {
|
|
"description": "References to pipelines",
|
|
"oneOf": [
|
|
{"$ref": "#/definitions/pipeline-array-ref"},
|
|
{"$ref": "#/definitions/pipeline-object-ref"}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
"""
|
|
|
|
|
|
class FilesInput(inputs.InputService):
|
|
|
|
@staticmethod
|
|
def map_pipeline_ref(store, ref, data, target):
|
|
filepath = data["file"].lstrip("/")
|
|
|
|
# prepare the mount point
|
|
filename = pathlib.Path(target, filepath)
|
|
os.makedirs(filename.parent, exist_ok=True)
|
|
filename.touch()
|
|
|
|
store.read_tree_at(ref, filename, filepath)
|
|
|
|
return filepath, data.get("metadata", {})
|
|
|
|
@staticmethod
|
|
def map_source_ref(source, ref, data, target):
|
|
os.link(f"{source}/{ref}", f"{target}/{ref}")
|
|
data = data.get("metadata", {})
|
|
return ref, data
|
|
|
|
def map(self, store, origin, refs, target, _options):
|
|
|
|
source = store.source("org.osbuild.files")
|
|
files = {}
|
|
|
|
for ref, data in refs.items():
|
|
if origin == "org.osbuild.source":
|
|
ref, data = self.map_source_ref(source, ref, data, target)
|
|
else:
|
|
ref, data = self.map_pipeline_ref(store, ref, data, target)
|
|
files[ref] = data
|
|
|
|
reply = {
|
|
"path": target,
|
|
"data": {
|
|
"files": files
|
|
}
|
|
}
|
|
return reply
|
|
|
|
|
|
def main():
|
|
service = FilesInput.from_args(sys.argv[1:])
|
|
service.main()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|