| 1 | package App::Workflow::Lint::Rule; | ||
| 2 | |||
| 3 | use strict; | ||
| 4 | use warnings; | ||
| 5 | use Carp qw(croak carp); | ||
| 6 | |||
| 7 | #---------------------------------------------------------------------- | ||
| 8 | # Base class for all lint rules. | ||
| 9 | #---------------------------------------------------------------------- | ||
| 10 | |||
| 11 | sub new { | ||
| 12 | my ($class, %opts) = @_; | ||
| 13 | return bless { %opts }, $class; | ||
| 14 | } | ||
| 15 | |||
| 16 | #---------------------------------------------------------------------- | ||
| 17 | # Metadata DSL | ||
| 18 | #---------------------------------------------------------------------- | ||
| 19 | |||
| 20 | sub id { croak ref($_[0]) . " must implement id()" } | ||
| 21 | sub description { croak ref($_[0]) . " must implement description()" } | ||
| 22 | sub level { 'warning' } | ||
| 23 | sub applies_to { 'workflow' } | ||
| 24 | |||
| 25 | #---------------------------------------------------------------------- | ||
| 26 | # Diagnostic builder | ||
| 27 | #---------------------------------------------------------------------- | ||
| 28 | |||
| 29 | sub diag { | ||
| 30 | my ($self, %args) = @_; | ||
| 31 | |||
| 32 | my $engine = $args{engine}; | ||
| 33 | my $line = $engine | ||
| 34 | ? $engine->line_for_path($args{file}, $args{path}) | ||
| 35 | : undef; | ||
| 36 | |||
| 37 | return { | ||
| 38 | rule => $self->id, | ||
| 39 | level => $self->level, | ||
| 40 | message => $args{message}, | ||
| 41 | path => $args{path} // '/', | ||
| 42 | file => $args{file}, | ||
| 43 | line => $line, | ||
| 44 | fix => $args{fix}, | ||
| 45 | }; | ||
| 46 | } | ||
| 47 | |||
| 48 | |||
| 49 | #---------------------------------------------------------------------- | ||
| 50 | # Scope-aware dispatcher | ||
| 51 | #---------------------------------------------------------------------- | ||
| 52 | |||
| 53 | sub check { | ||
| 54 | my ($self, $wf, $ctx) = @_; | ||
| 55 | |||
| 56 | my $scope = $self->applies_to; | ||
| 57 | |||
| 58 | if ($scope eq 'workflow') { | ||
| 59 | return $self->check_workflow($wf, $ctx); | ||
| 60 | } | ||
| 61 | elsif ($scope eq 'job') { | ||
| 62 | my @out; | ||
| 63 | for my $job_name (keys %{ $wf->{jobs} // {} }) { | ||
| 64 | my $job = $wf->{jobs}{$job_name}; | ||
| 65 | push @out, $self->check_job($job, { %$ctx, job_name => $job_name }); | ||
| 66 | } | ||
| 67 | return @out; | ||
| 68 | } | ||
| 69 | elsif ($scope eq 'step') { | ||
| 70 | my @out; | ||
| 71 | for my $job_name (keys %{ $wf->{jobs} // {} }) { | ||
| 72 | my $job = $wf->{jobs}{$job_name}; | ||
| 73 | for my $i (0 .. $#{ $job->{steps} // [] }) { | ||
| 74 | my $step = $job->{steps}[$i]; | ||
| 75 | push @out, $self->check_step($step, { | ||
| 76 | %$ctx, | ||
| 77 | job_name => $job_name, | ||
| 78 | step_index => $i, | ||
| 79 | }); | ||
| 80 | } | ||
| 81 | } | ||
| 82 | return @out; | ||
| 83 | } | ||
| 84 | |||
| 85 | croak "Unknown applies_to scope '$scope' in rule " . $self->id; | ||
| 86 | } | ||
| 87 | |||
| 88 | # Default no-op implementations | ||
| 89 | sub check_workflow { return () } | ||
| 90 | sub check_job { return () } | ||
| 91 | sub check_step { return () } | ||
| 92 | |||
| 93 | 1; | ||
| 94 |