module Hadolint.Rule.DL3049 (rule) where
import qualified Data.Map as Map
import qualified Data.Set as Set
import qualified Data.Sequence as Seq
import qualified Data.Text as Text
import Hadolint.Rule
import Language.Docker.Syntax
rule :: LabelSchema -> Rule args
rule :: forall args. LabelSchema -> Rule args
rule LabelSchema
labelschema = [Rule args] -> Rule args
forall a. Monoid a => [a] -> a
mconcat ([Rule args] -> Rule args) -> [Rule args] -> Rule args
forall a b. (a -> b) -> a -> b
$ (Text -> Rule args) -> [Text] -> [Rule args]
forall a b. (a -> b) -> [a] -> [b]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Text -> Rule args
forall args. Text -> Rule args
missingLabelRule (LabelSchema -> [Text]
forall k a. Map k a -> [k]
Map.keys LabelSchema
labelschema)
{-# INLINEABLE rule #-}
data StageID = StageID
{ StageID -> BaseImage
name :: BaseImage,
StageID -> Linenumber
line :: Linenumber
} deriving (StageID -> StageID -> Bool
(StageID -> StageID -> Bool)
-> (StageID -> StageID -> Bool) -> Eq StageID
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: StageID -> StageID -> Bool
== :: StageID -> StageID -> Bool
$c/= :: StageID -> StageID -> Bool
/= :: StageID -> StageID -> Bool
Eq, Eq StageID
Eq StageID =>
(StageID -> StageID -> Ordering)
-> (StageID -> StageID -> Bool)
-> (StageID -> StageID -> Bool)
-> (StageID -> StageID -> Bool)
-> (StageID -> StageID -> Bool)
-> (StageID -> StageID -> StageID)
-> (StageID -> StageID -> StageID)
-> Ord StageID
StageID -> StageID -> Bool
StageID -> StageID -> Ordering
StageID -> StageID -> StageID
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: StageID -> StageID -> Ordering
compare :: StageID -> StageID -> Ordering
$c< :: StageID -> StageID -> Bool
< :: StageID -> StageID -> Bool
$c<= :: StageID -> StageID -> Bool
<= :: StageID -> StageID -> Bool
$c> :: StageID -> StageID -> Bool
> :: StageID -> StageID -> Bool
$c>= :: StageID -> StageID -> Bool
>= :: StageID -> StageID -> Bool
$cmax :: StageID -> StageID -> StageID
max :: StageID -> StageID -> StageID
$cmin :: StageID -> StageID -> StageID
min :: StageID -> StageID -> StageID
Ord, Linenumber -> StageID -> ShowS
[StageID] -> ShowS
StageID -> String
(Linenumber -> StageID -> ShowS)
-> (StageID -> String) -> ([StageID] -> ShowS) -> Show StageID
forall a.
(Linenumber -> a -> ShowS)
-> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Linenumber -> StageID -> ShowS
showsPrec :: Linenumber -> StageID -> ShowS
$cshow :: StageID -> String
show :: StageID -> String
$cshowList :: [StageID] -> ShowS
showList :: [StageID] -> ShowS
Show)
data Acc
= Acc StageID (Set.Set StageID) (Set.Set StageID) (Set.Set StageID)
| Empty
deriving (Linenumber -> Acc -> ShowS
[Acc] -> ShowS
Acc -> String
(Linenumber -> Acc -> ShowS)
-> (Acc -> String) -> ([Acc] -> ShowS) -> Show Acc
forall a.
(Linenumber -> a -> ShowS)
-> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Linenumber -> Acc -> ShowS
showsPrec :: Linenumber -> Acc -> ShowS
$cshow :: Acc -> String
show :: Acc -> String
$cshowList :: [Acc] -> ShowS
showList :: [Acc] -> ShowS
Show)
missingLabelRule :: LabelName -> Rule args
missingLabelRule :: forall args. Text -> Rule args
missingLabelRule Text
label = (Linenumber -> State Acc -> Instruction args -> State Acc)
-> State Acc -> (State Acc -> Seq CheckFailure) -> Rule args
forall a args.
(Linenumber -> State a -> Instruction args -> State a)
-> State a -> (State a -> Seq CheckFailure) -> Rule args
veryCustomRule Linenumber -> State Acc -> Instruction args -> State Acc
forall {args}.
Linenumber -> State Acc -> Instruction args -> State Acc
check (Acc -> State Acc
forall a. a -> State a
emptyState Acc
Empty) State Acc -> Seq CheckFailure
markFailure
where
code :: RuleCode
code = RuleCode
"DL3049"
severity :: DLSeverity
severity = DLSeverity
DLInfoC
message :: Text
message = Text
"Label `" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
label Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"` is missing."
check :: Linenumber -> State Acc -> Instruction args -> State Acc
check Linenumber
line State Acc
state (From BaseImage
img) =
State Acc
state State Acc -> (State Acc -> State Acc) -> State Acc
forall a b. a -> (a -> b) -> b
|> (Acc -> Acc) -> State Acc -> State Acc
forall a. (a -> a) -> State a -> State a
modify (StageID -> Acc -> Acc
currentStage (BaseImage -> Linenumber -> StageID
StageID BaseImage
img Linenumber
line))
check Linenumber
_ State Acc
state (Copy (CopyArgs NonEmpty SourcePath
_ TargetPath
_) (CopyFlags Chown
_ Chmod
_ Link
_ (CopySource Text
src))) =
State Acc
state State Acc -> (State Acc -> State Acc) -> State Acc
forall a b. a -> (a -> b) -> b
|> (Acc -> Acc) -> State Acc -> State Acc
forall a. (a -> a) -> State a -> State a
modify (Text -> Acc -> Acc
markSilentByAlias Text
src)
check Linenumber
_ State Acc
state (Label Pairs
pairs)
| Text
label Text -> [Text] -> Bool
forall a. Eq a => a -> [a] -> Bool
forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` ((Text, Text) -> Text) -> Pairs -> [Text]
forall a b. (a -> b) -> [a] -> [b]
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (Text, Text) -> Text
forall a b. (a, b) -> a
fst Pairs
pairs =
State Acc
state
State Acc -> (State Acc -> State Acc) -> State Acc
forall a b. a -> (a -> b) -> b
|> (Acc -> Acc) -> State Acc -> State Acc
forall a. (a -> a) -> State a -> State a
modify (Text -> Acc -> Acc
markSilentByAlias (State Acc -> Text
getCurrentStageName State Acc
state))
State Acc -> (State Acc -> State Acc) -> State Acc
forall a b. a -> (a -> b) -> b
|> (Acc -> Acc) -> State Acc -> State Acc
forall a. (a -> a) -> State a -> State a
modify Acc -> Acc
markGood
| Bool
otherwise = State Acc
state
check Linenumber
_ State Acc
state Instruction args
_ = State Acc
state
markFailure :: State Acc -> Failures
markFailure :: State Acc -> Seq CheckFailure
markFailure (State Seq CheckFailure
fails (Acc StageID
_ Set StageID
_ Set StageID
_ Set StageID
b)) = (Seq CheckFailure -> CheckFailure -> Seq CheckFailure)
-> Seq CheckFailure -> Set CheckFailure -> Seq CheckFailure
forall a b. (a -> b -> a) -> a -> Set b -> a
Set.foldl' Seq CheckFailure -> CheckFailure -> Seq CheckFailure
forall a. Seq a -> a -> Seq a
(Seq.|>) Seq CheckFailure
fails ((StageID -> CheckFailure) -> Set StageID -> Set CheckFailure
forall b a. Ord b => (a -> b) -> Set a -> Set b
Set.map StageID -> CheckFailure
markFail Set StageID
b)
markFailure State Acc
st = State Acc -> Seq CheckFailure
forall a. State a -> Seq CheckFailure
failures State Acc
st
markFail :: StageID -> CheckFailure
markFail (StageID BaseImage
_ Linenumber
line) = CheckFailure {Linenumber
Text
RuleCode
DLSeverity
code :: RuleCode
severity :: DLSeverity
message :: Text
line :: Linenumber
code :: RuleCode
severity :: DLSeverity
message :: Text
line :: Linenumber
..}
currentStage :: StageID -> Acc -> Acc
currentStage :: StageID -> Acc -> Acc
currentStage StageID
stageid Acc
Empty = StageID -> Set StageID -> Set StageID -> Set StageID -> Acc
Acc StageID
stageid Set StageID
forall a. Set a
Set.empty Set StageID
forall a. Set a
Set.empty (StageID -> Set StageID
forall a. a -> Set a
Set.singleton StageID
stageid)
currentStage StageID
stageid (Acc StageID
_ Set StageID
g Set StageID
s Set StageID
b)
| Bool -> Bool
not (Bool -> Bool) -> Bool -> Bool
forall a b. (a -> b) -> a -> b
$ Set StageID -> Bool
forall a. Set a -> Bool
Set.null ((StageID -> Bool) -> Set StageID -> Set StageID
forall a. (a -> Bool) -> Set a -> Set a
Set.filter (StageID -> StageID -> Bool
predicate StageID
stageid) Set StageID
g) =
StageID -> Set StageID -> Set StageID -> Set StageID -> Acc
Acc StageID
stageid (Set StageID
g Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> StageID -> Set StageID -> Set StageID
forall a. Ord a => a -> Set a -> Set a
Set.insert StageID
stageid) Set StageID
s Set StageID
b
| Bool
otherwise = StageID -> Set StageID -> Set StageID -> Set StageID -> Acc
Acc StageID
stageid Set StageID
g Set StageID
s (Set StageID
b Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> StageID -> Set StageID -> Set StageID
forall a. Ord a => a -> Set a -> Set a
Set.insert StageID
stageid)
where
predicate :: StageID -> StageID -> Bool
predicate (StageID BaseImage
_ Linenumber
_) (StageID BaseImage {$sel:alias:BaseImage :: BaseImage -> Maybe ImageAlias
alias = Maybe ImageAlias
Nothing} Linenumber
_) = Bool
False
predicate (StageID BaseImage {Image
image :: Image
$sel:image:BaseImage :: BaseImage -> Image
image} Linenumber
_) (StageID BaseImage {$sel:alias:BaseImage :: BaseImage -> Maybe ImageAlias
alias = Just ImageAlias
als} Linenumber
_) =
ImageAlias -> Text
unImageAlias ImageAlias
als Text -> Text -> Bool
forall a. Eq a => a -> a -> Bool
== Image -> Text
imageName Image
image
markGood :: Acc -> Acc
markGood :: Acc -> Acc
markGood Acc
Empty = Acc
Empty
markGood (Acc StageID
stageid Set StageID
good Set StageID
silent Set StageID
bad) =
StageID -> Set StageID -> Set StageID -> Set StageID -> Acc
Acc StageID
stageid (Set StageID
good Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> StageID -> Set StageID -> Set StageID
forall a. Ord a => a -> Set a -> Set a
Set.insert StageID
stageid) (Set StageID
silent Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> StageID -> Set StageID -> Set StageID
forall a. Ord a => a -> Set a -> Set a
Set.delete StageID
stageid) (Set StageID
bad Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> StageID -> Set StageID -> Set StageID
forall a. Ord a => a -> Set a -> Set a
Set.delete StageID
stageid)
markSilentByAlias :: Text.Text -> Acc -> Acc
markSilentByAlias :: Text -> Acc -> Acc
markSilentByAlias Text
_ Acc
Empty = Acc
Empty
markSilentByAlias Text
silentname (Acc StageID
stageid Set StageID
good Set StageID
silent Set StageID
bad) =
StageID -> Set StageID -> Set StageID -> Set StageID -> Acc
Acc StageID
stageid Set StageID
good (Set StageID
silent Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> Set StageID -> Set StageID -> Set StageID
forall a. Ord a => Set a -> Set a -> Set a
Set.union Set StageID
stages) (Set StageID
bad Set StageID -> (Set StageID -> Set StageID) -> Set StageID
forall a b. a -> (a -> b) -> b
|> Set StageID -> Set StageID -> Set StageID
forall a. Ord a => Set a -> Set a -> Set a
remove Set StageID
stages)
where
stages :: Set StageID
stages = (StageID -> Bool) -> Set StageID -> Set StageID
forall a. (a -> Bool) -> Set a -> Set a
Set.filter StageID -> Bool
byName Set StageID
bad
byName :: StageID -> Bool
byName (StageID BaseImage {$sel:alias:BaseImage :: BaseImage -> Maybe ImageAlias
alias = Maybe ImageAlias
Nothing} Linenumber
_) = Bool
False
byName (StageID BaseImage {$sel:alias:BaseImage :: BaseImage -> Maybe ImageAlias
alias = Just ImageAlias
als} Linenumber
_) = ImageAlias -> Text
unImageAlias ImageAlias
als Text -> Text -> Bool
forall a. Eq a => a -> a -> Bool
== Text
silentname
remove :: Set a -> Set a -> Set a
remove Set a
set Set a
fromThis = Set a -> Set a -> Set a
forall a. Ord a => Set a -> Set a -> Set a
Set.difference Set a
fromThis Set a
set
getCurrentStageName :: State Acc -> Text.Text
getCurrentStageName :: State Acc -> Text
getCurrentStageName (State Seq CheckFailure
_ (Acc (StageID BaseImage {Image
$sel:image:BaseImage :: BaseImage -> Image
image :: Image
image, $sel:alias:BaseImage :: BaseImage -> Maybe ImageAlias
alias = Maybe ImageAlias
Nothing} Linenumber
_) Set StageID
_ Set StageID
_ Set StageID
_)) = Image -> Text
imageName Image
image
getCurrentStageName (State Seq CheckFailure
_ (Acc (StageID BaseImage {$sel:alias:BaseImage :: BaseImage -> Maybe ImageAlias
alias = Just ImageAlias
als} Linenumber
_) Set StageID
_ Set StageID
_ Set StageID
_)) = ImageAlias -> Text
unImageAlias ImageAlias
als
getCurrentStageName State Acc
_ = Text
""