Pierre-Olivier Mercier
621c76fbc0
Add an AutoFill attribute to the Field struct that marks option fields as automatically resolved by the software based on test context, rather than requiring user input. Auto-fill always overrides any user-provided value at execution time.
62 lines
2.8 KiB
Go
62 lines
2.8 KiB
Go
// This file is part of the happyDomain (R) project.
|
|
// Copyright (c) 2020-2025 happyDomain
|
|
// Authors: Pierre-Olivier Mercier, et al.
|
|
//
|
|
// This program is offered under a commercial and under the AGPL license.
|
|
// For commercial licensing, contact us at <contact@happydomain.org>.
|
|
//
|
|
// For AGPL licensing:
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"git.happydns.org/happyDomain/model"
|
|
)
|
|
|
|
type PluginStorage interface {
|
|
// ListAllPluginConfigurations retrieves the list of known Providers.
|
|
ListAllPluginConfigurations() (happydns.Iterator[happydns.PluginOptions], error)
|
|
|
|
// ListPluginConfiguration retrieves all providers own by the given User.
|
|
ListPluginConfiguration(string) ([]*happydns.PluginOptionsPositional, error)
|
|
|
|
// GetPluginConfiguration retrieves the full Provider with the given identifier and owner.
|
|
GetPluginConfiguration(string, *happydns.Identifier, *happydns.Identifier, *happydns.Identifier) ([]*happydns.PluginOptionsPositional, error)
|
|
|
|
// UpdatePluginConfiguration updates the fields of the given Provider.
|
|
UpdatePluginConfiguration(string, *happydns.Identifier, *happydns.Identifier, *happydns.Identifier, happydns.PluginOptions) error
|
|
|
|
// DeletePluginConfiguration removes the given Provider from the database.
|
|
DeletePluginConfiguration(string, *happydns.Identifier, *happydns.Identifier, *happydns.Identifier) error
|
|
|
|
// ClearPluginConfigurations deletes all Providers present in the database.
|
|
ClearPluginConfigurations() error
|
|
}
|
|
|
|
// PluginAutoFillStorage provides the domain/zone/user lookups needed to
|
|
// resolve auto-fill variables for test plugin options.
|
|
type PluginAutoFillStorage interface {
|
|
// GetDomain retrieves the Domain with the given identifier.
|
|
GetDomain(domainid happydns.Identifier) (*happydns.Domain, error)
|
|
|
|
// GetUser retrieves the User with the given identifier.
|
|
GetUser(userid happydns.Identifier) (*happydns.User, error)
|
|
|
|
// ListDomains retrieves all Domains associated to the given User.
|
|
ListDomains(user *happydns.User) ([]*happydns.Domain, error)
|
|
|
|
// GetZone retrieves the full Zone (including Services and metadata) for the given identifier.
|
|
GetZone(zoneid happydns.Identifier) (*happydns.ZoneMessage, error)
|
|
}
|