coverage

Documentation

Index

• type EntityCoverageInfo
• type SchemaCoverage
• type SchemaCoverageInfo
  • func Run(shape file.Shape) SchemaCoverageInfo

Types

type EntityCoverageInfo

type EntityCoverageInfo struct {
	EntityName string

	UncoveredRelationships       []string
	CoverageRelationshipsPercent int

	UncoveredAttributes       []string
	CoverageAttributesPercent int

	UncoveredAssertions       map[string][]string
	CoverageAssertionsPercent map[string]int
}

EntityCoverageInfo - Entity coverage info

type SchemaCoverage

type SchemaCoverage struct {
	EntityName    string
	Relationships []string
	Attributes    []string
	Assertions    []string
}

SchemaCoverage

schema:

entity user {}

entity organization {
    // organizational roles
    relation admin @user
    relation member @user
}

entity repository {
    // represents repositories parent organization
    relation parent @organization

    // represents owner of this repository
    relation owner  @user @organization#admin

    // permissions
    permission edit   = parent.admin or owner
    permission delete = owner
}

- relationships coverage

organization#admin@user organization#member@user repository#parent@organization repository#owner@user repository#owner@organization#admin

- assertions coverage

repository#edit repository#delete

type SchemaCoverageInfo

type SchemaCoverageInfo struct {
	EntityCoverageInfo         []EntityCoverageInfo
	TotalRelationshipsCoverage int
	TotalAttributesCoverage    int
	TotalAssertionsCoverage    int
}

SchemaCoverageInfo - Schema coverage info

func Run

func Run(shape file.Shape) SchemaCoverageInfo