summaryrefslogtreecommitdiff
path: root/lib/chef/resource/apt_update.rb
blob: f6916ac68132ffa2f5d02436727427f713436745 (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
#
# Author:: Thom May (<thom@chef.io>)
# Copyright:: Copyright (c) 2016-2020, 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 "../resource"

class Chef
  class Resource
    class AptUpdate < Chef::Resource
      unified_mode true

      provides(:apt_update) { true }

      description "Use the apt_update resource to manage APT repository updates on Debian and Ubuntu platforms."
      introduced "12.7"
      examples <<~DOC
        Update the Apt repository at a specified interval
        ```ruby
        apt_update 'all platforms' do
        frequency 86400
        action :periodic
        end
        ```

        Update the Apt repository at the start of a Chef Infra Client run
        ```ruby
        apt_update 'update'
        ```
      DOC

      # allow bare apt_update with no name
      property :name, String, default: ""

      property :frequency, Integer,
        description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the :periodic action is specified.",
        default: 86_400

      default_action :periodic
      allowed_actions :update, :periodic

      action_class do
        APT_CONF_DIR = "/etc/apt/apt.conf.d".freeze
        STAMP_DIR = "/var/lib/apt/periodic".freeze

        # Determines whether we need to run `apt-get update`
        #
        # @return [Boolean]
        def apt_up_to_date?
          ::File.exist?("#{STAMP_DIR}/update-success-stamp") &&
            ::File.mtime("#{STAMP_DIR}/update-success-stamp") > Time.now - new_resource.frequency
        end

        def do_update
          [STAMP_DIR, APT_CONF_DIR].each do |d|
            directory d do
              recursive true
            end
          end

          file "#{APT_CONF_DIR}/15update-stamp" do
            content "APT::Update::Post-Invoke-Success {\"touch #{STAMP_DIR}/update-success-stamp 2>/dev/null || true\";};\n"
            action :create_if_missing
          end

          execute "apt-get -q update" do
            command [ "apt-get", "-q", "update" ]
            default_env true
          end
        end
      end

      action :periodic do
        return unless debian?

        unless apt_up_to_date?
          converge_by "update new lists of packages" do
            do_update
          end
        end
      end

      action :update do
        return unless debian?

        converge_by "force update new lists of packages" do
          do_update
        end
      end

    end
  end
end