summaryrefslogtreecommitdiff
path: root/spec/unit/face/module/list_spec.rb
blob: fa7a5521e05234db21700da100be89ef8b4d7cf0 (plain)
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# encoding: UTF-8

require 'spec_helper'
require 'puppet/face'
require 'puppet/module_tool'
require 'puppet_spec/modules'

describe "puppet module list" do
  include PuppetSpec::Files

  around do |example|
    dir = tmpdir("deep_path")

    FileUtils.mkdir_p(@modpath1 = File.join(dir, "modpath1"))
    FileUtils.mkdir_p(@modpath2 = File.join(dir, "modpath2"))
    FileUtils.mkdir_p(@modpath3 = File.join(dir, "modpath3"))

    env = Puppet::Node::Environment.create(:env, [@modpath1, @modpath2])
    Puppet.override(:current_environment => env) do
      example.run
    end
  end

  it "should return an empty list per dir in path if there are no modules" do
    Puppet::Face[:module, :current].list[:modules_by_path].should == {
      @modpath1 => [],
      @modpath2 => []
    }
  end

  it "should include modules separated by the environment's modulepath" do
    foomod1 = PuppetSpec::Modules.create('foo', @modpath1)
    barmod1 = PuppetSpec::Modules.create('bar', @modpath1)
    foomod2 = PuppetSpec::Modules.create('foo', @modpath2)

    usedenv = Puppet::Node::Environment.create(:useme, [@modpath1, @modpath2, @modpath3])

    Puppet.override(:environments => Puppet::Environments::Static.new(usedenv)) do
      Puppet::Face[:module, :current].list(:environment => 'useme')[:modules_by_path].should == {
        @modpath1 => [
          Puppet::Module.new('bar', barmod1.path, usedenv),
          Puppet::Module.new('foo', foomod1.path, usedenv)
        ],
        @modpath2 => [Puppet::Module.new('foo', foomod2.path, usedenv)],
        @modpath3 => [],
      }
    end
  end

  it "should use the specified environment" do
    foomod = PuppetSpec::Modules.create('foo', @modpath1)
    barmod = PuppetSpec::Modules.create('bar', @modpath1)

    usedenv = Puppet::Node::Environment.create(:useme, [@modpath1, @modpath2, @modpath3])

    Puppet.override(:environments => Puppet::Environments::Static.new(usedenv)) do
      Puppet::Face[:module, :current].list(:environment => 'useme')[:modules_by_path].should == {
        @modpath1 => [
          Puppet::Module.new('bar', barmod.path, usedenv),
          Puppet::Module.new('foo', foomod.path, usedenv)
        ],
        @modpath2 => [],
        @modpath3 => [],
      }
    end
  end

  it "should use the specified modulepath" do
    foomod = PuppetSpec::Modules.create('foo', @modpath1)
    barmod = PuppetSpec::Modules.create('bar', @modpath2)

    modules = Puppet::Face[:module, :current].list(:modulepath => "#{@modpath1}#{File::PATH_SEPARATOR}#{@modpath2}")[:modules_by_path]

    expect(modules[@modpath1].first.name).to eq('foo')
    expect(modules[@modpath1].first.path).to eq(foomod.path)
    expect(modules[@modpath1].first.environment.modulepath).to eq([@modpath1, @modpath2])

    expect(modules[@modpath2].first.name).to eq('bar')
    expect(modules[@modpath2].first.path).to eq(barmod.path)
    expect(modules[@modpath2].first.environment.modulepath).to eq([@modpath1, @modpath2])
  end

  it "prefers a given modulepath over the modulepath from the given environment" do
    foomod = PuppetSpec::Modules.create('foo', @modpath1)
    barmod = PuppetSpec::Modules.create('bar', @modpath2)
    env = Puppet::Node::Environment.create(:myenv, ['/tmp/notused'])

    modules = Puppet::Face[:module, :current].list(:environment => 'myenv', :modulepath => "#{@modpath1}#{File::PATH_SEPARATOR}#{@modpath2}")[:modules_by_path]

    expect(modules[@modpath1].first.name).to eq('foo')
    expect(modules[@modpath1].first.path).to eq(foomod.path)
    expect(modules[@modpath1].first.environment.modulepath).to eq([@modpath1, @modpath2])
    expect(modules[@modpath1].first.environment.name).to_not eq(:myenv)

    expect(modules[@modpath2].first.name).to eq('bar')
    expect(modules[@modpath2].first.path).to eq(barmod.path)
    expect(modules[@modpath2].first.environment.modulepath).to eq([@modpath1, @modpath2])
    expect(modules[@modpath2].first.environment.name).to_not eq(:myenv)
  end

  describe "inline documentation" do
    subject { Puppet::Face[:module, :current].get_action(:list) }

    its(:summary)     { should =~ /list.*module/im }
    its(:description) { should =~ /list.*module/im }
    its(:returns)     { should =~ /hash of paths to module objects/i }
    its(:examples)    { should_not be_empty }
  end

  describe "when rendering to console" do
    let(:face) { Puppet::Face[:module, :current] }
    let(:action) { face.get_action(:list) }

    def console_output(options={})
      result = face.list(options)
      action.when_rendering(:console).call(result, options)
    end

    it "should explicitly state when a modulepath is empty" do
      empty_modpath = tmpdir('empty')

      expected = <<-HEREDOC.gsub('        ', '')
        #{empty_modpath} (no modules installed)
      HEREDOC

      console_output(:modulepath => empty_modpath).should == expected
    end

    it "should print both modules with and without metadata" do
      modpath = tmpdir('modpath')

      PuppetSpec::Modules.create('nometadata', modpath)
      PuppetSpec::Modules.create('metadata', modpath, :metadata => {:author => 'metaman'})

      env = Puppet::Node::Environment.create(:environ, [modpath])
      Puppet.override(:current_environment => env) do
        expected = <<-HEREDOC.gsub('          ', '')
          #{modpath}
          ├── metaman-metadata (\e[0;36mv9.9.9\e[0m)
          └── nometadata (\e[0;36m???\e[0m)
        HEREDOC

        console_output.should == expected
      end
    end

    it "should print the modulepaths in the order they are in the modulepath setting" do
      path1 = tmpdir('b')
      path2 = tmpdir('c')
      path3 = tmpdir('a')

      env = Puppet::Node::Environment.create(:environ, [path1, path2, path3])
      Puppet.override(:current_environment => env) do
        expected = <<-HEREDOC.gsub('          ', '')
          #{path1} (no modules installed)
          #{path2} (no modules installed)
          #{path3} (no modules installed)
        HEREDOC

        console_output.should == expected
      end
    end

    it "should print dependencies as a tree" do
      PuppetSpec::Modules.create('dependable', @modpath1, :metadata => { :version => '0.0.5'})
      PuppetSpec::Modules.create(
        'other_mod',
        @modpath1,
        :metadata => {
          :version => '1.0.0',
          :dependencies => [{
            "version_requirement" => ">= 0.0.5",
            "name"                => "puppetlabs/dependable"
          }]
        }
      )

      expected = <<-HEREDOC.gsub('        ', '')
        #{@modpath1}
        └─┬ puppetlabs-other_mod (\e[0;36mv1.0.0\e[0m)
          └── puppetlabs-dependable (\e[0;36mv0.0.5\e[0m)
        #{@modpath2} (no modules installed)
      HEREDOC

      console_output(:tree => true).should == expected
    end

    it "should print both modules with and without metadata as a tree" do
      PuppetSpec::Modules.create('nometadata', @modpath1)
      PuppetSpec::Modules.create('metadata', @modpath1, :metadata => {:author => 'metaman'})

      expected = <<-HEREDOC.gsub('        ', '')
        #{@modpath1}
        ├── metaman-metadata (\e[0;36mv9.9.9\e[0m)
        └── nometadata (\e[0;36m???\e[0m)
        #{@modpath2} (no modules installed)
      HEREDOC

      console_output.should == expected
    end

    it "should warn about missing dependencies" do
      PuppetSpec::Modules.create('depender', @modpath1, :metadata => {
        :version => '1.0.0',
        :dependencies => [{
          "version_requirement" => ">= 0.0.5",
          "name"                => "puppetlabs/dependable"
        }]
      })

      warning_expectations = [
        regexp_matches(/Missing dependency 'puppetlabs-dependable'/),
        regexp_matches(/'puppetlabs-depender' \(v1\.0\.0\) requires 'puppetlabs-dependable' \(>= 0\.0\.5\)/)
      ]

      Puppet.expects(:warning).with(all_of(*warning_expectations))

      console_output(:tree => true)
    end

    it "should warn about out of range dependencies" do
      PuppetSpec::Modules.create('dependable', @modpath1, :metadata => { :version => '0.0.1'})
      PuppetSpec::Modules.create('depender', @modpath1, :metadata => {
        :version => '1.0.0',
        :dependencies => [{
          "version_requirement" => ">= 0.0.5",
          "name"                => "puppetlabs/dependable"
        }]
      })

      warning_expectations = [
        regexp_matches(/Module 'puppetlabs-dependable' \(v0\.0\.1\) fails to meet some dependencies/),
        regexp_matches(/'puppetlabs-depender' \(v1\.0\.0\) requires 'puppetlabs-dependable' \(>= 0\.0\.5\)/)
      ]

      Puppet.expects(:warning).with(all_of(*warning_expectations))

      console_output(:tree => true)
    end
  end
end