types.go

package houston

// Response wraps all houston response structs used for json marashalling
type Response struct {
	Data struct {
		AddWorkspaceUser               *Workspace                `json:"workspaceAddUser,omitempty"`
		RemoveWorkspaceUser            *Workspace                `json:"workspaceRemoveUser,omitempty"`
		CreateDeployment               *Deployment               `json:"createDeployment,omitempty"`
		CreateToken                    *AuthUser                 `json:"createToken,omitempty"`
		CreateWorkspaceServiceAccount  *WorkspaceServiceAccount  `json:"createWorkspaceServiceAccount,omitempty"`
		CreateDeploymentServiceAccount *DeploymentServiceAccount `json:"createDeploymentServiceAccount,omitempty"`
		CreateUser                     *AuthUser                 `json:"createUser,omitempty"`
		CreateWorkspace                *Workspace                `json:"createWorkspace,omitempty"`
		DeleteDeployment               *Deployment               `json:"deleteDeployment,omitempty"`
		DeleteWorkspaceServiceAccount  *ServiceAccount           `json:"deleteWorkspaceServiceAccount,omitempty"`
		DeleteDeploymentServiceAccount *ServiceAccount           `json:"deleteDeploymentServiceAccount,omitempty"`
		DeleteWorkspace                *Workspace                `json:"deleteWorkspace,omitempty"`
		GetDeployments                 []Deployment              `json:"workspaceDeployments,omitempty"`
		GetAuthConfig                  *AuthConfig               `json:"authConfig,omitempty"`
		GetAppConfig                   *AppConfig                `json:"appConfig,omitempty"`
		GetServiceAccounts             []ServiceAccount          `json:"serviceAccounts,omitempty"`
		GetUsers                       []User                    `json:"users,omitempty"`
		GetWorkspaces                  []Workspace               `json:"workspaces,omitempty"`
		UpdateDeployment               *Deployment               `json:"updateDeployment,omitempty"`
		UpdateWorkspace                *Workspace                `json:"updateWorkspace,omitempty"`
		DeploymentLog                  []DeploymentLog           `json:"logs,omitempty"`
		WorkspaceUpdateUserRole        string                    `json:"workspaceUpdateUserRole,omitempty"`
		DeploymentConfig               DeploymentConfig          `json:"deploymentConfig,omitempty"`
	} `json:"data"`
	Errors []Error `json:"errors,omitempty"`
}

type AuthProvider struct {
	Name        string `json:"name"`
	DisplayName string `json:"displayName"`
	Url         string `json:"url"`
}

// AuthConfig holds data related to oAuth and basic authentication
type AuthConfig struct {
	LocalEnabled  bool           `json:"localEnabled"`
	PublicSignup  bool           `json:"publicSignup"`
	InitialSignup bool           `json:"initialSignup"`
	AuthProviders []AuthProvider `json:"providers"`
}

type AuthUser struct {
	User  User  `json:"user"`
	Token Token `json:"token"`
}

// Decoded defines structure of a houston response Decoded object
type Decoded struct {
	ID  string `json:"id"`
	SU  bool   `json:"sU"`
	Iat int    `json:"iat"`
	Exp int    `json:"exp"`
}

// Deployment defines structure of a houston response Deployment object
type Deployment struct {
	Id             string          `json:"id"`
	Type           string          `json:"type"`
	Label          string          `json:"label"`
	ReleaseName    string          `json:"releaseName"`
	Version        string          `json:"version"`
	DeploymentInfo DeploymentInfo  `json:"deployInfo"`
	Workspace      Workspace       `json:"workspace"`
	Urls           []DeploymentUrl `json:"urls"`
	CreatedAt      string          `json:"createdAt"`
	UpdatedAt      string          `json:"updatedAt"`
}

// DeploymentUrl defines structure of a houston response DeploymentUrl object
type DeploymentUrl struct {
	Type string `json:"type"`
	Url  string `json:"url"`
}

// DeploymentInfo contains registry related information for a deployment
type DeploymentInfo struct {
	NextCli string `json:"NextCli"`
	Current string `json:"current"`
}

// Email contains various pieces of a users email
type Email struct {
	Address  string `json:"address"`
	Verified bool   `json:"verified"`
	Primary  bool   `json:"primary"`
	// created at
	// updated at
}

// Error defines struct of a houston response Error object
type Error struct {
	Message string `json:"message"`
	Name    string `json:"name"`
}

// Status defines structure of a houston response StatusResponse object
type Status struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	Code    string `json:"code"`
	Id      string `json:"id"`
}

// ServiceAccount defines a structure of a ServiceAccountResponse object
type ServiceAccount struct {
	Id         string `json:"id"`
	ApiKey     string `json:"apiKey"`
	Label      string `json:"label"`
	Category   string `json:"category"`
	EntityType string `json:"entityType"`
	EntityId   string `json:"entityUuid"`
	LastUsedAt string `json:"lastUsedAt"`
	CreatedAt  string `json:"createdAt"`
	UpdatedAt  string `json:"updatedAt"`
	Active     bool   `json:"active"`
}

// WorkspaceServiceAccount defines a structure of a WorkspaceServiceAccountResponse object
type WorkspaceServiceAccount struct {
	Id            string `json:"id"`
	ApiKey        string `json:"apiKey"`
	Label         string `json:"label"`
	Category      string `json:"category"`
	EntityType    string `json:"entityType"`
	WorkspaceUuid string `json:"workspaceUuid"`
	LastUsedAt    string `json:"lastUsedAt"`
	CreatedAt     string `json:"createdAt"`
	UpdatedAt     string `json:"updatedAt"`
	Active        bool   `json:"active"`
}

// DeploymentServiceAccount defines a structure of a DeploymentServiceAccountResponse object
type DeploymentServiceAccount struct {
	Id             string `json:"id"`
	ApiKey         string `json:"apiKey"`
	Label          string `json:"label"`
	Category       string `json:"category"`
	EntityType     string `json:"entityType"`
	DeploymentUuid string `json:"deploymentUuid"`
	LastUsedAt     string `json:"lastUsedAt"`
	CreatedAt      string `json:"createdAt"`
	UpdatedAt      string `json:"updatedAt"`
	Active         bool   `json:"active"`
}

// Token contains a houston auth token as well as it's payload of components
type Token struct {
	Value   string       `json:"value"`
	Payload TokenPayload `json:"payload"`
}

// TokenPayload contains components of a houston auth token
type TokenPayload struct {
	Id  string `json:"id"`
	Iat int    `json:"iat"`
	Exp int    `json:"exp"`
}

// User contains all components of an Astronomer user
type User struct {
	Id       string  `json:"id"`
	Emails   []Email `json:"emails"`
	Username string  `json:"username"`
	Status   string  `json:"status"`
	// created at
	// updated at
	// profile
}

type RoleBinding struct {
	Role string `json:"role"`
	User struct {
		Id       string `json:"id"`
		Username string `json:"username"`
	} `json:"user"`
}

// Workspace contains all components of an Astronomer Workspace
type Workspace struct {
	Id          string `json:"id"`
	Label       string `json:"label"`
	Description string `json:"description"`
	Users       []User `json:"users"`
	// groups
	CreatedAt    string        `json:"createdAt"`
	UpdatedAt    string        `json:"updatedAt"`
	RoleBindings []RoleBinding `json:"roleBindings"`
}

// DeploymentLog contains all log related to deployment components
type DeploymentLog struct {
	Id        string `json:"id"`
	Component string `json:"component"`
	CreatedAt string `json:"createdAt"`
	Log       string `json:"log"`
}

// AirflowImage contains all airflow image attributes
type AirflowImage struct {
	Version string `json:"version"`
	Tag     string `json:"tag"`
}

// DeploymentConfig contains current airflow image tag
type DeploymentConfig struct {
	AirflowImages          []AirflowImage `json:"airflowImages"`
	DefaultAirflowImageTag string         `json:"defaultAirflowImageTag"`
}

func (config *DeploymentConfig) GetValidTags() (tags []string) {
	for _, image := range config.AirflowImages {
		tags = append(tags, image.Tag)
	}
	return
}

func (config *DeploymentConfig) IsValidTag(tag string) bool {
	for _, validTag := range config.GetValidTags() {
		if tag == validTag {
			return true
		}
	}
	return false
}

// AppConfig contains current houston config
type AppConfig struct {
	Version            string `json:"version"`
	BaseDomain         string `json:"baseDomain"`
	SmtpConfigured     bool   `json:"smtpConfigured"`
	ManualReleaseNames bool   `json:"manualReleaseNames"`
}