project

Documentation

Index

• type CasePermissions
• type ExecutionPermissions
• type Label
  • func NewLabel(name, description, color string) Label
• type MemberPermissions
• type Permissions
• type Project
  • func NewProject(name string, owner id.ActorID, description string, ...) Project
  • func (p Project) AddMember(member id.ActorID)
  • func (p Project) GetLabelByName(labelName string) (Label, error)
  • func (p *Project) GetPermissions(u *user.User) Permissions
  • func (p Project) ID() id.ProjectID
  • func (p *Project) IsOwner(u *user.User) bool
  • func (p Project) ItemName() string
  • func (p Project) ItemVisibility() visibility.Visibility
  • func (p Project) RemoveMember(member *user.User)
• type Role
• type RoleName
  • func (r *RoleName) String() string
• type SequencePermissions
• type SettingsPermissions
• type UserMembership
  • func NewUserMembership(u id.ActorID) UserMembership
• type Variant
• type Version

Types

type CasePermissions

type CasePermissions struct {
	CreateCase    bool
	EditCase      bool
	DeleteCase    bool
	DuplicateCase bool
	AssignCase    bool
}

CasePermissions are the permissions affecting the cases in a project

type ExecutionPermissions

type ExecutionPermissions struct {
	Execute bool
}

ExecutionPermissions are the permissions affecting the execution

type Label

type Label struct {
	Name        string
	Description string
	Color       string
}

A Label is used to group tests

func NewLabel

func NewLabel(name, description, color string) Label

NewLabel creates a new label

type MemberPermissions

type MemberPermissions struct {
	EditMembers bool
}

MemberPermissions are the permissions affecting the members in a project

type Permissions

type Permissions struct {
	ExecutionPermissions
	CasePermissions
	SequencePermissions
	MemberPermissions
	SettingsPermissions
}

Permissions are all permissions that a user can have in a project

type Project

type Project struct {
	Name         string
	Description  string
	Visibility   visibility.Visibility
	CreationDate time.Time
	Owner        id.ActorID
	Variants     map[string]*Variant
	Labels       []Label
	UserMembers  map[id.ActorID]UserMembership
	Roles        map[RoleName]*Role
}

The Project struct contains information used to describe a project in the system

func NewProject

func NewProject(name string, owner id.ActorID, description string, visibility visibility.Visibility) Project

NewProject creates a new project

func (Project) AddMember

func (p Project) AddMember(member id.ActorID)

AddMember adds the given user to the project It creates a UserMembership with the role "Tester".

func (Project) GetLabelByName

func (p Project) GetLabelByName(labelName string) (Label, error)

GetLabelByName gets a label of a project by name

func (*Project) GetPermissions

func (p *Project) GetPermissions(u *user.User) Permissions

GetPermissions returns the permissions of a user in a project. Returns an empty permission struct if the user does not exist in the project.

func (Project) ID

func (p Project) ID() id.ProjectID

ID returns a projects id

func (*Project) IsOwner

func (p *Project) IsOwner(u *user.User) bool

IsOwner checks whether the user is owner of the project. Returns false if the project or the user is nil or if the user is not the owner.

func (Project) ItemName

func (p Project) ItemName() string

ItemName returns a projects name

func (Project) ItemVisibility

func (p Project) ItemVisibility() visibility.Visibility

ItemVisibility returns a projects visibility

func (Project) RemoveMember

func (p Project) RemoveMember(member *user.User)

RemoveMember removes the given user of the project

type Role

type Role struct {
	Name        RoleName
	Permissions Permissions
}

A Role defines the permissions a user has in a project. It has a name and permissions.

type RoleName

type RoleName string

A RoleName is the name of a role in a project

func (*RoleName) String

func (r *RoleName) String() string

String returns the RoleName as string

type SequencePermissions

type SequencePermissions struct {
	CreateSequence    bool
	EditSequence      bool
	DeleteSequence    bool
	DuplicateSequence bool
	AssignSequence    bool
}

SequencePermissions are the permissions affecting the sequences in a project

type SettingsPermissions

type SettingsPermissions struct {
	EditProject     bool // Change name, description, image, visibility
	DeleteProject   bool
	EditPermissions bool
}

SettingsPermissions are the permissions affecting the settings of a project

type UserMembership

type UserMembership struct {
	User        id.ActorID
	Role        RoleName
	MemberSince time.Time
}

UserMembership contains information about the membership of a user in a project

func NewUserMembership

func NewUserMembership(u id.ActorID) UserMembership

NewUserMembership creates a new membership with the user. The role of the member is set to tester by default. Returns a UserMembership.

type Variant

type Variant struct {
	Name     string
	Versions []Version
}

The Variant struct contains the name of a system under test variant and its versions

type Version

type Version struct {
	Name string
}

The Version struct represents a system under test version