summaryrefslogtreecommitdiff
path: root/lib/chef/resource/homebrew_cask.rb
blob: 7c47fbbfcde6fd25b24d6a08ca0025c413e57ffd (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
#
# Author:: Joshua Timberman (<jtimberman@chef.io>)
# Author:: Graeme Mathieson (<mathie@woss.name>)
#
# Copyright:: 2011-2018, Chef Software, Inc.
#
# 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"
require "chef/mixin/homebrew_user"

class Chef
  class Resource
    class HomebrewCask < Chef::Resource
      resource_name :homebrew_cask
      provides(:homebrew_cask) { true }

      description "Use the homebrew_cask resource to install binaries distributed via the Homebrew package manager."
      introduced "14.0"

      include Chef::Mixin::HomebrewUser

      property :cask_name, String,
               description: "The name of the Homebrew cask, if it differs from the resource block name.",
               regex: %r{^[\w/-]+$},
               validation_message: "The provided Homebrew cask name is not valid. Cask names can contain alphanumeric characters, _, -, or / only!",
               name_property: true

      property :options, String,
               description: "Options to pass to the brew command during installation."

      property :install_cask, [TrueClass, FalseClass],
               description: "Automatically install the Homebrew cask tap, if necessary.",
               default: true

      property :homebrew_path, String,
               description: "The path to the homebrew binary.",
               default: "/usr/local/bin/brew"

      property :owner, String,
               description: "The owner of the Homebrew installation.",
               default: lazy { find_homebrew_username }

      action :install do
        description "Install an application packaged as a Homebrew cask."

        homebrew_tap "caskroom/cask" if new_resource.install_cask

        unless casked?
          converge_by("install cask #{new_resource.name} #{new_resource.options}") do
            shell_out!("#{new_resource.homebrew_path} cask install #{new_resource.name} #{new_resource.options}",
                user: new_resource.owner,
                env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
                cwd: ::Dir.home(new_resource.owner))
          end
        end
      end

      action :remove do
        description "Remove an application packaged as a Homebrew cask."

        homebrew_tap "caskroom/cask" if new_resource.install_cask

        if casked?
          converge_by("uninstall cask #{new_resource.name}") do
            shell_out!("#{new_resource.homebrew_path} cask uninstall #{new_resource.name}",
                user: new_resource.owner,
                env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
                cwd: ::Dir.home(new_resource.owner))
          end
        end
      end

      action_class do
        alias_method :action_cask, :action_install
        alias_method :action_uncask, :action_remove
        alias_method :action_uninstall, :action_remove

        def casked?
          unscoped_name = new_resource.name.split("/").last
          shell_out!('#{new_resource.homebrew_path} cask list 2>/dev/null',
            user: new_resource.owner,
            env:  { "HOME" => ::Dir.home(new_resource.owner), "USER" => new_resource.owner },
            cwd: ::Dir.home(new_resource.owner)).stdout.split.include?(unscoped_name)
        end
      end
    end
  end
end