tms

Documentation

Index

• Constants
• func FormNodeIdExtDescriptorMappingWithValidation(utils TmsUtils, nodeNameExtDescriptorMapping map[string]interface{}, ...) (map[int64]string, error)
• func GetYamlAsMap(utils TmsUtils, yamlPath string) (map[string]interface{}, error)
• func UploadDescriptors(config Options, communicationInstance CommunicationInterface, utils TmsUtils) error
• func UploadFile(config Options, communicationInstance CommunicationInterface, utils TmsUtils) (string, error)
• type CommunicationInstance
  • func NewCommunicationInstance(httpClient piperHttp.Uploader, tmsUrl, uaaUrl, clientId, clientSecret string, ...) (*CommunicationInstance, error)
  • func (communicationInstance *CommunicationInstance) ExportFileToNode(nodeName, fileId, description, namedUser string) (NodeUploadResponseEntity, error)
  • func (communicationInstance *CommunicationInstance) GetMtaExtDescriptor(nodeId int64, mtaId, mtaVersion string) (MtaExtDescriptor, error)
  • func (communicationInstance *CommunicationInstance) GetNodes() ([]Node, error)
  • func (communicationInstance *CommunicationInstance) UpdateMtaExtDescriptor(nodeId, idOfMtaExtDescriptor int64, ...) (MtaExtDescriptor, error)
  • func (communicationInstance *CommunicationInstance) UploadFile(file, namedUser string) (FileInfo, error)
  • func (communicationInstance *CommunicationInstance) UploadFileToNode(nodeName, fileId, description, namedUser string) (NodeUploadResponseEntity, error)
  • func (communicationInstance *CommunicationInstance) UploadMtaExtDescriptorToNode(nodeId int64, file, mtaVersion, description, namedUser string) (MtaExtDescriptor, error)
• type CommunicationInterface
  • func SetupCommunication(config Options) (communicationInstance CommunicationInterface)
• type Entry
• type FileInfo
• type MtaExtDescriptor
• type Node
• type NodeUploadRequestEntity
• type NodeUploadResponseEntity
• type Options
• type QueueEntry
• type TmsUtils
  • func NewTmsUtils() TmsUtils

Constants

const DEFAULT_TR_DESCRIPTION = "Created by Piper"

Functions

func FormNodeIdExtDescriptorMappingWithValidation

func FormNodeIdExtDescriptorMappingWithValidation(utils TmsUtils, nodeNameExtDescriptorMapping map[string]interface{}, nodes []Node, mtaYamlMap map[string]interface{}, mtaVersion string) (map[int64]string, error)

func GetYamlAsMap

func GetYamlAsMap(utils TmsUtils, yamlPath string) (map[string]interface{}, error)

func UploadDescriptors

func UploadDescriptors(config Options, communicationInstance CommunicationInterface, utils TmsUtils) error

func UploadFile

func UploadFile(config Options, communicationInstance CommunicationInterface, utils TmsUtils) (string, error)

Types

type CommunicationInstance

type CommunicationInstance struct {
	// contains filtered or unexported fields
}

func NewCommunicationInstance

func NewCommunicationInstance(httpClient piperHttp.Uploader, tmsUrl, uaaUrl, clientId, clientSecret string, isVerbose bool, clientOptions piperHttp.ClientOptions) (*CommunicationInstance, error)

NewCommunicationInstance returns CommunicationInstance structure with http client prepared for communication with TMS backend

func (*CommunicationInstance) ExportFileToNode

func (communicationInstance *CommunicationInstance) ExportFileToNode(nodeName, fileId, description, namedUser string) (NodeUploadResponseEntity, error)

func (*CommunicationInstance) GetMtaExtDescriptor

func (communicationInstance *CommunicationInstance) GetMtaExtDescriptor(nodeId int64, mtaId, mtaVersion string) (MtaExtDescriptor, error)

func (*CommunicationInstance) GetNodes

func (communicationInstance *CommunicationInstance) GetNodes() ([]Node, error)

func (*CommunicationInstance) UpdateMtaExtDescriptor

func (communicationInstance *CommunicationInstance) UpdateMtaExtDescriptor(nodeId, idOfMtaExtDescriptor int64, file, mtaVersion, description, namedUser string) (MtaExtDescriptor, error)

func (*CommunicationInstance) UploadFile

func (communicationInstance *CommunicationInstance) UploadFile(file, namedUser string) (FileInfo, error)

func (*CommunicationInstance) UploadFileToNode

func (communicationInstance *CommunicationInstance) UploadFileToNode(nodeName, fileId, description, namedUser string) (NodeUploadResponseEntity, error)

func (*CommunicationInstance) UploadMtaExtDescriptorToNode

func (communicationInstance *CommunicationInstance) UploadMtaExtDescriptorToNode(nodeId int64, file, mtaVersion, description, namedUser string) (MtaExtDescriptor, error)

type CommunicationInterface

type CommunicationInterface interface {
	GetNodes() ([]Node, error)
	GetMtaExtDescriptor(nodeId int64, mtaId, mtaVersion string) (MtaExtDescriptor, error)
	UpdateMtaExtDescriptor(nodeId, idOfMtaExtDescriptor int64, file, mtaVersion, description, namedUser string) (MtaExtDescriptor, error)
	UploadMtaExtDescriptorToNode(nodeId int64, file, mtaVersion, description, namedUser string) (MtaExtDescriptor, error)
	UploadFile(file, namedUser string) (FileInfo, error)
	UploadFileToNode(nodeName, fileId, description, namedUser string) (NodeUploadResponseEntity, error)
	ExportFileToNode(nodeName, fileId, description, namedUser string) (NodeUploadResponseEntity, error)
}

func SetupCommunication

func SetupCommunication(config Options) (communicationInstance CommunicationInterface)

type Entry

type Entry struct {
	Uri string `json:"uri"`
}

type FileInfo

type FileInfo struct {
	Id   int64  `json:"fileId"`
	Name string `json:"fileName"`
}

type MtaExtDescriptor

type MtaExtDescriptor struct {
	Id            int64  `json:"id"`
	Description   string `json:"description"`
	MtaId         string `json:"mtaId"`
	MtaExtId      string `json:"mtaExtId"`
	MtaVersion    string `json:"mtaVersion"`
	LastChangedAt string `json:"lastChangedAt"`
}

type Node

type Node struct {
	Id   int64  `json:"id"`
	Name string `json:"name"`
}

type NodeUploadRequestEntity

type NodeUploadRequestEntity struct {
	ContentType string  `json:"contentType"`
	StorageType string  `json:"storageType"`
	NodeName    string  `json:"nodeName"`
	Description string  `json:"description"`
	NamedUser   string  `json:"namedUser"`
	Entries     []Entry `json:"entries"`
}

type NodeUploadResponseEntity

type NodeUploadResponseEntity struct {
	TransportRequestId          int64        `json:"transportRequestId"`
	TransportRequestDescription string       `json:"transportRequestDescription"`
	QueueEntries                []QueueEntry `json:"queueEntries"`
}

type Options

type Options struct {
	TmsServiceKey            string                 `json:"tmsServiceKey,omitempty"`
	CustomDescription        string                 `json:"customDescription,omitempty"`
	NamedUser                string                 `json:"namedUser,omitempty"`
	NodeName                 string                 `json:"nodeName,omitempty"`
	MtaPath                  string                 `json:"mtaPath,omitempty"`
	MtaVersion               string                 `json:"mtaVersion,omitempty"`
	NodeExtDescriptorMapping map[string]interface{} `json:"nodeExtDescriptorMapping,omitempty"`
	Proxy                    string                 `json:"proxy,omitempty"`
	StashContent             []string               `json:"stashContent,omitempty"`
	Verbose                  bool
}

type QueueEntry

type QueueEntry struct {
	Id       int64  `json:"queueId"`
	NodeId   int64  `json:"nodeId"`
	NodeName string `json:"nodeName"`
}

type TmsUtils

type TmsUtils interface {
	command.ExecRunner
	FileExists(filename string) (bool, error)
	FileRead(path string) ([]byte, error)
}

func NewTmsUtils

func NewTmsUtils() TmsUtils