types/plugin.go - main - githubmirror/gitness

types/plugin.go
66 строк2 KB
Johannes Batzill
[MISC] Move `UID` to `Identifier` to match Harness Standards (#992)
30 янв 2024, 02:29
30 янв 2024, 02:29adf2046
// Copyright 2023 Harness, Inc.
//
// 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 types

import "encoding/json"

// Plugin represents a Harness plugin. It has an associated template stored
// in the spec field. The spec is used by the UI to provide a smart visual
// editor for adding plugins to YAML schema.
type Plugin struct {
	Identifier  string `db:"plugin_uid"               json:"identifier"`
	Description string `db:"plugin_description"       json:"description"`
	// Currently we only support step level plugins but more can be added in the future.
	Type    string `db:"plugin_type"              json:"type"`
	Version string `db:"plugin_version"           json:"version"`
	Logo    string `db:"plugin_logo"              json:"logo"`
	// Spec is a YAML template to be used for the plugin.
	Spec string `db:"plugin_spec"                     json:"spec"`
}

// Matches checks whether two plugins are identical.
// We can use reflection here, this is just easier to add on to
// when needed.
func (p *Plugin) Matches(v *Plugin) bool {
	if p.Identifier != v.Identifier {
		return false
	}
	if p.Description != v.Description {
		return false
	}
	if p.Spec != v.Spec {
		return false
	}
	if p.Version != v.Version {
		return false
	}
	if p.Logo != v.Logo {
		return false
	}
	return true
}

// TODO [CODE-1363]: remove after identifier migration.
func (p Plugin) MarshalJSON() ([]byte, error) {
	// alias allows us to embed the original object while avoiding an infinite loop of marshaling.
	type alias Plugin
	return json.Marshal(&struct {
		alias
		UID string `json:"uid"`
	}{
		alias: (alias)(p),
		UID:   p.Identifier,
	})
}