summaryrefslogtreecommitdiff
path: root/lib/chef/resource/script.rb
blob: 056d2743ccd703ce39eb8618a0dc9867de7eb515 (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
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Tyler Cloke (<tyler@chef.io>)
# Copyright:: Copyright 2008-2017, 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_relative "execute"

class Chef
  class Resource
    class Script < Chef::Resource::Execute
      unified_mode true

      resource_name :script

      identity_attr :name

      description "Use the script resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby."\
                  " This resource may also use any of the actions and properties that are available to the execute resource. Commands"\
                  " that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the"\
                  " environment in which they are run. Use not_if and only_if to guard this resource for idempotence."

      def initialize(name, run_context = nil)
        super
        @command = nil
        @default_guard_interpreter = :default
      end

      # FIXME: remove this and use an execute sub-resource instead of inheriting from Execute
      def command(arg = nil)
        super
        unless arg.nil?
          raise Chef::Exceptions::Script, "Do not use the command property on a #{resource_name} resource, use the 'code' property instead."
        end
      end

      property :code, String, required: true
      property :interpreter, String
      property :flags, String

    end
  end
end