Copyright	(c) Red Hat 2022
License	Apache-2.0
Maintainer	tdecacqu@redhat.com, fboucher@redhat.com
Stability	provisional
Portability	portable
Safe Haskell	Safe-Inferred
Language	GHC2021

ZuulWeeder.Graph

Description

This module contains the core configuration graph. The config analysis results looks like this: demo-graph

Synopsis

type ConfigGraph = Graph Vertex
data Analysis = Analysis {
- dependencyGraph :: ConfigGraph
- dependentGraph :: ConfigGraph
- vertices :: Set Vertex
- names :: Map VertexName (Set TenantName)
- config :: Config
- graphErrors :: [String]
}
data Vertex = Vertex {
- name :: VertexName
- tenants :: Set TenantName
}
data VertexName
analyzeConfig :: TenantsConfig -> Config -> Analysis
findReachable :: NonEmpty Vertex -> ConfigGraph -> Set Vertex
findReachableForest :: Maybe (Set TenantName) -> NonEmpty Vertex -> ConfigGraph -> Forest VertexName

Documentation

type ConfigGraph = Graph Vertex Source #

A convenient type alias.

data Analysis Source #

The config analysis result used by the ZuulWeeder.UI module.

Constructors

Analysis

Fields

dependencyGraph :: ConfigGraph
The requirements graph, e.g. job requires nodeset.
dependentGraph :: ConfigGraph
The dependents graph, e.g. nodeset allows job.
vertices :: Set Vertex
The list of vertex, used for displaying search result.
names :: Map VertexName (Set TenantName)
A map of all the names and their matching tenants, used for searching.
config :: Config
The zuul config.
graphErrors :: [String]
A list of error found when building the analysis.

Instances

Instances details

Generic Analysis Source #
Instance details Defined in ZuulWeeder.Graph Associated Types type Rep Analysis :: Type -> Type # Methods from :: Analysis -> Rep Analysis x # to :: Rep Analysis x -> Analysis #
Show Analysis Source #
Instance details Defined in ZuulWeeder.Graph Methods showsPrec :: Int -> Analysis -> ShowS # show :: Analysis -> String # showList :: [Analysis] -> ShowS #
type Rep Analysis Source #
Instance details Defined in ZuulWeeder.Graph type Rep Analysis = D1 ('MetaData "Analysis" "ZuulWeeder.Graph" "zuul-weeder-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Analysis" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dependencyGraph") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConfigGraph) :: (S1 ('MetaSel ('Just "dependentGraph") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConfigGraph) :: S1 ('MetaSel ('Just "vertices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Vertex)))) :: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map VertexName (Set TenantName))) :: (S1 ('MetaSel ('Just "config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Config) :*: S1 ('MetaSel ('Just "graphErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))))

data Vertex Source #

The graph vertex

Constructors

Vertex
Fields name :: VertexName The vertex identifier tenants :: Set TenantName The list of tenants using that vertex

Instances

Instances details

Generic Vertex Source #
Instance details Defined in ZuulWeeder.Graph Associated Types type Rep Vertex :: Type -> Type # Methods from :: Vertex -> Rep Vertex x # to :: Rep Vertex x -> Vertex #
Show Vertex Source #
Instance details Defined in ZuulWeeder.Graph Methods showsPrec :: Int -> Vertex -> ShowS # show :: Vertex -> String # showList :: [Vertex] -> ShowS #
Eq Vertex Source #
Instance details Defined in ZuulWeeder.Graph Methods (==) :: Vertex -> Vertex -> Bool # (/=) :: Vertex -> Vertex -> Bool #
Ord Vertex Source #
Instance details Defined in ZuulWeeder.Graph Methods compare :: Vertex -> Vertex -> Ordering # (<) :: Vertex -> Vertex -> Bool # (<=) :: Vertex -> Vertex -> Bool # (>) :: Vertex -> Vertex -> Bool # (>=) :: Vertex -> Vertex -> Bool # max :: Vertex -> Vertex -> Vertex # min :: Vertex -> Vertex -> Vertex #
Hashable Vertex Source #
Instance details Defined in ZuulWeeder.Graph Methods hashWithSalt :: Int -> Vertex -> Int # hash :: Vertex -> Int #
type Rep Vertex Source #
Instance details Defined in ZuulWeeder.Graph type Rep Vertex = D1 ('MetaData "Vertex" "ZuulWeeder.Graph" "zuul-weeder-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Vertex" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VertexName) :*: S1 ('MetaSel ('Just "tenants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set TenantName))))

data VertexName Source #

A Vertex can be a raw zuul config element, or a custom element added through analysis

Constructors

VAbstractJob JobName	An abstract job
VJob JobName	A job
VSecret SecretName	A secret
VSemaphore SemaphoreName	A semaphore
VNodeset NodesetName	A nodeset
VNodeLabel NodeLabelName	A node label
VQueue QueueName	A queue
VProject CanonicalProjectName	A project
VProjectRegex ProjectRegex	A project regex
VProjectTemplate ProjectTemplateName	A project template
VPipeline PipelineName	A pipeline
VProjectPipeline PipelineName CanonicalProjectName	A project pipeline config
VRegexPipeline PipelineName ProjectRegex	A project regex config
VTemplatePipeline PipelineName ProjectTemplateName	A template pipeline config
VTrigger ConnectionName	A pipeline trigger
VReporter ConnectionName	A pipeline reporter

Instances

Instances details

Generic VertexName Source #
Instance details Defined in ZuulWeeder.Graph Associated Types type Rep VertexName :: Type -> Type # Methods from :: VertexName -> Rep VertexName x # to :: Rep VertexName x -> VertexName #
Show VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods showsPrec :: Int -> VertexName -> ShowS # show :: VertexName -> String # showList :: [VertexName] -> ShowS #
Eq VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods (==) :: VertexName -> VertexName -> Bool # (/=) :: VertexName -> VertexName -> Bool #
Ord VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods compare :: VertexName -> VertexName -> Ordering # (<) :: VertexName -> VertexName -> Bool # (<=) :: VertexName -> VertexName -> Bool # (>) :: VertexName -> VertexName -> Bool # (>=) :: VertexName -> VertexName -> Bool # max :: VertexName -> VertexName -> VertexName # min :: VertexName -> VertexName -> VertexName #
Hashable VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods hashWithSalt :: Int -> VertexName -> Int # hash :: VertexName -> Int #
From CanonicalProjectName VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: CanonicalProjectName -> VertexName #
From Job VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: Job -> VertexName #
From NodeLabelName VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: NodeLabelName -> VertexName #
From Nodeset VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: Nodeset -> VertexName #
From Pipeline VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: Pipeline -> VertexName #
From ProjectRegex VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: ProjectRegex -> VertexName #
From ProjectTemplate VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: ProjectTemplate -> VertexName #
From QueueName VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: QueueName -> VertexName #
From SecretName VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: SecretName -> VertexName #
From SemaphoreName VertexName Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: SemaphoreName -> VertexName #
From VertexName Text Source #
Instance details Defined in ZuulWeeder.Graph Methods from :: VertexName -> Text #
type Rep VertexName Source #
Instance details Defined in ZuulWeeder.Graph type Rep VertexName = D1 ('MetaData "VertexName" "ZuulWeeder.Graph" "zuul-weeder-0.1.0.0-inplace" 'False) ((((C1 ('MetaCons "VAbstractJob" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobName)) :+: C1 ('MetaCons "VJob" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobName))) :+: (C1 ('MetaCons "VSecret" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecretName)) :+: C1 ('MetaCons "VSemaphore" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SemaphoreName)))) :+: ((C1 ('MetaCons "VNodeset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodesetName)) :+: C1 ('MetaCons "VNodeLabel" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeLabelName))) :+: (C1 ('MetaCons "VQueue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueueName)) :+: C1 ('MetaCons "VProject" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CanonicalProjectName))))) :+: (((C1 ('MetaCons "VProjectRegex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectRegex)) :+: C1 ('MetaCons "VProjectTemplate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectTemplateName))) :+: (C1 ('MetaCons "VPipeline" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PipelineName)) :+: C1 ('MetaCons "VProjectPipeline" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PipelineName) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CanonicalProjectName)))) :+: ((C1 ('MetaCons "VRegexPipeline" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PipelineName) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectRegex)) :+: C1 ('MetaCons "VTemplatePipeline" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PipelineName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProjectTemplateName))) :+: (C1 ('MetaCons "VTrigger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConnectionName)) :+: C1 ('MetaCons "VReporter" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConnectionName))))))

analyzeConfig :: TenantsConfig -> Config -> Analysis Source #

The main function to build the Analysis .

findReachable Source #

Arguments

:: NonEmpty Vertex	The list of `Vertex` to search
-> ConfigGraph	The graph to search in
-> Set Vertex	The list of reachable `Vertex`

Return the list of reachable Vertex

findReachableForest Source #

Arguments

:: Maybe (Set TenantName)
-> NonEmpty Vertex	The list of `Vertex` to search
-> ConfigGraph	The graph to search in
-> Forest VertexName	The forest

Return the forest of reachable Vertex