summaryrefslogtreecommitdiff
path: root/lib/chef/resource/breakpoint.rb
blob: 1ccc4311b3f02ca32a682548f044ae0de6f930b5 (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
#
# Author:: Daniel DeLeo (<dan@kallistec.com>)
# Copyright:: Copyright 2008-2016, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "chef/resource"

class Chef
  class Resource
    class Breakpoint < Chef::Resource
      provides :breakpoint
      resource_name :breakpoint

      description "Use the breakpoint resource to add breakpoints to recipes. Run the"\
                  " chef-shell in chef-client mode, and then use those breakpoints to debug"\
                  " recipes. Breakpoints are ignored by the chef-client during an actual"\
                  " chef-client run. That said, breakpoints are typically used to debug"\
                  " recipes only when running them in a non-production environment, after"\
                  " which they are removed from those recipes before the parent cookbook is"\
                  " uploaded to the Chef server."
      introduced "12.0"

      default_action :break

      def initialize(action = "break", *args)
        super(caller.first, *args)
      end

      action :break do
        if defined?(Shell) && Shell.running?
          with_run_context :parent do
            run_context.resource_collection.iterator.pause
            new_resource.updated_by_last_action(true)
            run_context.resource_collection.iterator
          end
        end
      end
    end
  end
end