efbaa93eef
The `KojiTargetResultOptions` previously contained information only about the uploaded image file. And even then, some information, such as the filename, were scattered in other structures such as `KojiFinalizeJob` struct. Since the plan is to start uploading also osbuild manifest and osbuild build log to Koji, we need to extend the result options structure to hold more information and also make it specific to which file is the information related. Rework the `KojiTargetResultOptions` to contain information about: - the built image - build log - osbuild manifest Information about each file contains: - filename - checksum type - file checksum - file size For now, only the built image information is set and consumed by the worker. Add custom JSON (un)marshaler for `KojiTargetResultOptions` to handle backward compatibility when old version of worker or composer server interact with each other. Cover them with unit tests. Signed-off-by: Tomáš Hozza <thozza@redhat.com>
122 lines
3.7 KiB
Go
122 lines
3.7 KiB
Go
package target
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
)
|
|
|
|
const TargetNameKoji TargetName = "org.osbuild.koji"
|
|
|
|
type KojiTargetOptions struct {
|
|
UploadDirectory string `json:"upload_directory"`
|
|
Server string `json:"server"`
|
|
}
|
|
|
|
func (KojiTargetOptions) isTargetOptions() {}
|
|
|
|
func NewKojiTarget(options *KojiTargetOptions) *Target {
|
|
return newTarget(TargetNameKoji, options)
|
|
}
|
|
|
|
// ChecksumType represents the type of a checksum used for a KojiOutputInfo.
|
|
type ChecksumType string
|
|
|
|
const (
|
|
ChecksumTypeMD5 ChecksumType = "md5"
|
|
|
|
// Only MD5 is supported for now to enable backwards compatibility.
|
|
// The reason is tha the old KojiTargetOptions contained only
|
|
// ImageMD5 and ImageSize fields, which mandates the use of MD5.
|
|
// TODO: uncomment the lines below when the backwards compatibility is no longer needed.
|
|
//ChecksumTypeAdler32 ChecksumType = "adler32"
|
|
//ChecksumTypeSHA256 ChecksumType = "sha256"
|
|
)
|
|
|
|
// KojiOutputInfo represents the information about any output file uploaded to Koji
|
|
// as part of the OSBuild job. This information is then used by the KojiFinalize
|
|
// job when importing files into Koji.
|
|
type KojiOutputInfo struct {
|
|
Filename string `json:"filename"`
|
|
ChecksumType ChecksumType `json:"checksum_type"`
|
|
Checksum string `json:"checksum"`
|
|
Size uint64 `json:"size"`
|
|
}
|
|
|
|
type KojiTargetResultOptions struct {
|
|
Image *KojiOutputInfo `json:"image"`
|
|
Log *KojiOutputInfo `json:"log,omitempty"`
|
|
OSBuildManifest *KojiOutputInfo `json:"osbuild_manifest,omitempty"`
|
|
}
|
|
|
|
func (o *KojiTargetResultOptions) UnmarshalJSON(data []byte) error {
|
|
type aliasType KojiTargetResultOptions
|
|
if err := json.Unmarshal(data, (*aliasType)(o)); err != nil {
|
|
return err
|
|
}
|
|
|
|
// compatType contains deprecated fields, which are being checked
|
|
// for backwards compatibility.
|
|
type compatType struct {
|
|
// Deprecated: Use Image in KojiTargetOptions instead.
|
|
// Kept for backwards compatibility.
|
|
ImageMD5 string `json:"image_md5"`
|
|
ImageSize uint64 `json:"image_size"`
|
|
}
|
|
|
|
var compat compatType
|
|
if err := json.Unmarshal(data, &compat); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Check if the Image data in the new struct format are set.
|
|
// If not, then the data are coming from an old composer.
|
|
if o.Image == nil {
|
|
// o.Image.Filename is kept empty, because the filename was previously
|
|
// not set as there was always only the Image file. The KojiFinalize job
|
|
// handles this case and takes the Image filename from the KojiFinalizeJob
|
|
// options.
|
|
|
|
o.Image = &KojiOutputInfo{
|
|
ChecksumType: ChecksumTypeMD5,
|
|
Checksum: compat.ImageMD5,
|
|
Size: compat.ImageSize,
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (o KojiTargetResultOptions) MarshalJSON() ([]byte, error) {
|
|
type alias KojiTargetResultOptions
|
|
// compatType is a super-set of the current KojiTargetResultOptions and
|
|
// old version of it. It contains deprecated fields, which are being set
|
|
// for backwards compatibility.
|
|
type compatType struct {
|
|
alias
|
|
|
|
// Deprecated: Use Image in KojiTargetOptions instead.
|
|
// Kept for backwards compatibility.
|
|
ImageMD5 string `json:"image_md5"`
|
|
ImageSize uint64 `json:"image_size"`
|
|
}
|
|
|
|
// Only MD5 is supported for now to enable backwards compatibility.
|
|
// TODO: remove this block when the backwards compatibility is no longer needed.
|
|
if o.Image.ChecksumType != ChecksumTypeMD5 {
|
|
return nil, fmt.Errorf("unsupported checksum type: %s", o.Image.ChecksumType)
|
|
}
|
|
|
|
compat := compatType{
|
|
alias: (alias)(o),
|
|
ImageMD5: o.Image.Checksum,
|
|
ImageSize: o.Image.Size,
|
|
}
|
|
|
|
return json.Marshal(compat)
|
|
}
|
|
|
|
func (KojiTargetResultOptions) isTargetResultOptions() {}
|
|
|
|
func NewKojiTargetResult(options *KojiTargetResultOptions) *TargetResult {
|
|
return newTargetResult(TargetNameKoji, options)
|
|
}
|