collectors

Documentation

Index

• func CollectMissingPermissions(missingPermissionChan chan MissingPermission)
• func FullRepoName(org string, repo string) string
• func InitBaseCollector(b *BaseCollector, c Collector)
• type BaseCollector
  • func (b *BaseCollector) CollectData(org githubcollected.ExtendedOrg, entity collected.Entity, canonicalLink string, ...)
  • func (b *BaseCollector) CollectDataWithContext(entity collected.Entity, canonicalLink string, ctx CollectedDataContext)
  • func (b *BaseCollector) CollectionChange(change int)
  • func (b *BaseCollector) CollectionChangeByOne()
  • func (b *BaseCollector) IssueMissingPermissions(missingPermissions ...MissingPermission)
  • func (b *BaseCollector) WrappedCollection(collection func()) SubCollectorChannels
• type CollectedData
• type CollectedDataContext
• type CollectedDataRepositoryContext
• type CollectionMetric
• type Collector
• type Metadata
• type MissingPermission
  • func NewMissingPermission(permission, entity, effect string, namespace namespace.Namespace) MissingPermission
• type SubCollectorChannels

Functions

func CollectMissingPermissions

func CollectMissingPermissions(missingPermissionChan chan MissingPermission)

func FullRepoName

func FullRepoName(org string, repo string) string

func InitBaseCollector

func InitBaseCollector(b *BaseCollector, c Collector)

Types

type BaseCollector

type BaseCollector struct {
	Collector
	// contains filtered or unexported fields
}

func (*BaseCollector) CollectData

func (b *BaseCollector) CollectData(org githubcollected.ExtendedOrg, entity collected.Entity, canonicalLink string, viewerRoles []permissions.Role)

func (*BaseCollector) CollectDataWithContext

func (b *BaseCollector) CollectDataWithContext(entity collected.Entity, canonicalLink string, ctx CollectedDataContext)

func (*BaseCollector) CollectionChange

func (b *BaseCollector) CollectionChange(change int)

func (*BaseCollector) CollectionChangeByOne

func (b *BaseCollector) CollectionChangeByOne()

func (*BaseCollector) IssueMissingPermissions

func (b *BaseCollector) IssueMissingPermissions(missingPermissions ...MissingPermission)

func (*BaseCollector) WrappedCollection

func (b *BaseCollector) WrappedCollection(collection func()) SubCollectorChannels

type CollectedData

type CollectedData struct {
	Context       CollectedDataContext
	Entity        collected.Entity
	Namespace     namespace.Namespace
	CanonicalLink string
}

type CollectedDataContext

type CollectedDataContext interface {
	Premium() bool
	Roles() []permissions.Role
}

type CollectedDataRepositoryContext

type CollectedDataRepositoryContext interface {
	CollectedDataContext
	HasBranchProtectionPermission() bool
}

type CollectionMetric

type CollectionMetric struct {
	CollectionChange int
	Finished         bool
	Namespace        string
}

type Collector

type Collector interface {
	Collect() SubCollectorChannels
	Namespace() namespace.Namespace
	CollectMetadata() Metadata
}

type Metadata

type Metadata struct {
	TotalEntities int
}

type MissingPermission

type MissingPermission struct {
	Permission string
	Entity     string
	Effect     string
	Namespace  namespace.Namespace
}

func NewMissingPermission

func NewMissingPermission(permission, entity, effect string, namespace namespace.Namespace) MissingPermission

type SubCollectorChannels

type SubCollectorChannels struct {
	Collected         <-chan CollectedData
	Progress          <-chan CollectionMetric
	MissingPermission <-chan MissingPermission
}