File: compile.rb

package info (click to toggle)
ruby-rspec-puppet 4.0.2%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,444 kB
  • sloc: ruby: 6,377; makefile: 6
file content (172 lines) | stat: -rw-r--r-- 4,593 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# frozen_string_literal: true

module RSpec::Puppet
  module ManifestMatchers
    class Compile
      def initialize
        @failed_resource = ''
        @check_deps = false
        @cycles = []
        @error_msg = ''
      end

      def with_all_deps
        @check_deps = true
        self
      end

      def and_raise_error(error)
        @expected_error = error
        self
      end

      def matches?(catalogue)
        @catalogue = catalogue.call

        if cycles_found?
          false
        elsif @check_deps == true && missing_dependencies?
          false
        else
          @expected_error.nil?
        end
      rescue Puppet::Error => e
        @error_msg = e.message
        if @expected_error.nil?
          false
        else
          method = @expected_error.is_a?(Regexp) ? :=~ : :==
          e.message.send(method, @expected_error)
        end
      end

      def description
        case @expected_error
        when nil
          'compile into a catalogue without dependency cycles'
        when Regexp
          "fail to compile and raise an error matching #{@expected_error.inspect}"
        else
          "fail to compile and raise the error #{@expected_error.inspect}"
        end
      end

      def failure_message
        if @cycles.empty?
          if @error_msg.empty?
            case @expected_error
            when nil
              "expected that the catalogue would include #{@failed_resource}"
            when Regexp
              "expected that the catalogue would fail to compile and raise an error matching #{@expected_error.inspect}"
            else
              "expected that the catalogue would fail to compile and raise the error #{@expected_error.inspect}"
            end
          else
            "error during compilation: #{@error_msg}"
          end
        else
          "dependency cycles found: #{@cycles.join('; ')}"
        end
      end

      def failure_message_when_negated
        if @expected_error.nil?
          'expected that the catalogue would not compile but it does'
        else
          'expected that the catalogue would compile but it does not'
        end
      end

      def supports_block_expectations
        true
      end

      def supports_value_expectations
        true
      end

      private

      def missing_dependencies?
        retval = false

        resource_vertices = @catalogue.vertices.select { |v| v.is_a? Puppet::Resource }
        resource_vertices.each do |vertex|
          vertex.each do |param, value|
            next unless %i[require subscribe notify before].include? param

            value = [value] unless value.is_a? Array
            value.each do |val|
              retval = true if val.is_a?(Puppet::Resource) && !resource_exists?(val, vertex)
            end
          end
        end

        retval
      end

      def resource_hash
        @resource_hash ||= proc do
          res_hash = {}
          @catalogue.vertices.each do |vertex|
            next unless vertex.is_a? Puppet::Resource

            res_hash[vertex.ref] = 1
            res_hash["#{vertex.type}[#{vertex[:alias]}]"] = 1 if vertex[:alias]

            res_hash["#{vertex.type}[#{vertex.uniqueness_key.first}]"] = 1 if vertex.uniqueness_key != [vertex.title]
          end
          res_hash
        end.call
      end

      def check_resource(res)
        if resource_hash[res.ref]
          true
        elsif res[:alias] && resource_hash["#{res.type}[#{res[:alias]}]"]
          true
        else
          false
        end
      end

      def resource_exists?(res, vertex)
        if check_resource(res)
          true
        else
          @failed_resource = "#{res.ref} used at #{vertex.file}:#{vertex.line} in #{vertex.ref}"
          false
        end
      end

      def cycles_found?
        cat = @catalogue.to_ral.relationship_graph
        cat.write_graph(:resources)
        if cat.respond_to? :find_cycles_in_graph
          find_cycles(cat)
        else
          find_cycles_legacy(cat)
        end

        !@cycles.empty?
      end

      def find_cycles(catalogue)
        cycles = catalogue.find_cycles_in_graph
        return unless cycles.length.positive?

        cycles.each do |cycle|
          paths = catalogue.paths_in_cycle(cycle)
          @cycles << (paths.map { |path| "(#{path.join(' => ')})" }.join("\n") + "\n")
        end
      end

      def find_cycles_legacy(catalogue)
        catalogue.topsort
      rescue Puppet::Error => e
        @cycles = [e.message.rpartition(';').first.partition(':').last]
      end
    end
  end
end