Class: Autoproj::Ops::Cache

Inherits:
Object
  • Object
show all
Defined in:
lib/autoproj/ops/cache.rb

Defined Under Namespace

Classes: CompilationFailed

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cache_dir, ws) ⇒ Cache

Returns a new instance of Cache.



7
8
9
10
11
 
# File 'lib/autoproj/ops/cache.rb', line 7

def initialize(cache_dir, ws)
    @cache_dir = cache_dir
    @ws = ws
    @manifest = ws.manifest
end

Instance Attribute Details

#cache_dir ⇒ Object (readonly)

Returns the value of attribute cache_dir.



4
5
6
 
# File 'lib/autoproj/ops/cache.rb', line 4

def cache_dir
  @cache_dir
end

#manifest ⇒ Object (readonly)

Returns the value of attribute manifest.



5
6
7
 
# File 'lib/autoproj/ops/cache.rb', line 5

def manifest
  @manifest
end

Instance Method Details

#archive_cache_dir ⇒ Object 



64
65
66
 
# File 'lib/autoproj/ops/cache.rb', line 64

def archive_cache_dir
    File.join(cache_dir, "archives")
end

#cache_archive(pkg) ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/autoproj/ops/cache.rb', line 68

def cache_archive(pkg)
    pkg.importer.cachedir = archive_cache_dir
    with_retry(10) do
        pkg.importer.update_cache(pkg)
    end
end

#cache_git(pkg, checkout_only: false) ⇒ Object 



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
 
# File 'lib/autoproj/ops/cache.rb', line 29

def cache_git(pkg, checkout_only: false)
    pkg.importdir = File.join(git_cache_dir, pkg.name)
    return if checkout_only && File.directory?(pkg.importdir)

    pkg.importer.local_branch = nil
    pkg.importer.remote_branch = nil
    pkg.importer.remote_name = "autobuild"

    unless File.directory?(pkg.importdir)
        FileUtils.mkdir_p File.dirname(pkg.importdir)
        Autobuild::Subprocess.run(
            "autoproj-cache", "import", Autobuild.tool(:git),
            "--git-dir", pkg.importdir, "init", "--bare"
        )
    end
    pkg.importer.update_remotes_configuration(pkg, only_local: false)

    with_retry(10) do
        Autobuild::Subprocess.run(
            "autoproj-cache", :import, Autobuild.tool("git"),
            "--git-dir", pkg.importdir, "remote", "update", "autobuild"
        )
    end
    with_retry(10) do
        Autobuild::Subprocess.run(
            "autoproj-cache", :import, Autobuild.tool("git"),
            "--git-dir", pkg.importdir, "fetch", "autobuild", "--tags"
        )
    end
    Autobuild::Subprocess.run(
        "autoproj-cache", :import, Autobuild.tool("git"),
        "--git-dir", pkg.importdir, "gc", "--prune=all"
    )
end

#create_or_update(*package_names, all: true, keep_going: false, checkout_only: false) ⇒ Object 



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
 
# File 'lib/autoproj/ops/cache.rb', line 75

def create_or_update(*package_names, all: true, keep_going: false,
    checkout_only: false)
    FileUtils.mkdir_p cache_dir

    packages =
        if package_names.empty?
            if all
                manifest.each_autobuild_package
            else
                manifest.all_selected_source_packages.map(&:autobuild)
            end
        else
            package_names.map do |name|
                if (pkg = manifest.find_autobuild_package(name))
                    pkg
                else
                    raise PackageNotFound, "no package named #{name}"
                end
            end
        end

    packages = packages.sort_by(&:name)

    total = packages.size
    Autoproj.message "Handling #{total} packages"
    packages.each_with_index do |pkg, i|
        # No need to process this one, it is uses another package's
        # import
        next if pkg.srcdir != pkg.importdir

        begin
            case pkg.importer
            when Autobuild::Git
                Autoproj.message(
                    "  [#{i}/#{total}] caching #{pkg.name} (git)"
                )
                cache_git(pkg, checkout_only: checkout_only)
            when Autobuild::ArchiveImporter
                Autoproj.message(
                    "  [#{i}/#{total}] caching #{pkg.name} (archive)"
                )
                cache_archive(pkg)
            else
                Autoproj.message(
                    "  [#{i}/#{total}] not caching #{pkg.name} "\
                    "(cannot cache #{pkg.importer.class})"
                )
            end
        rescue Interrupt
            raise
        rescue ::Exception => e
            raise unless keep_going

            pkg.error "       failed to cache #{pkg.name}, "\
                      "but going on as requested"
            lines = e.to_s.split('\n')
            lines = e.message.split('\n') if lines.empty?
            lines = ["unknown error"] if lines.empty?
            pkg.message(lines.shift, :red, :bold)
            lines.each do |line|
                pkg.message(line)
            end
            nil
        end
    end
end

#create_or_update_gems(keep_going: true, compile_force: false, compile: []) ⇒ Object 



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
 
# File 'lib/autoproj/ops/cache.rb', line 146

def create_or_update_gems(keep_going: true, compile_force: false, compile: [])
    # Note: this might directly copy into the cache directoy, and
    # we support it later
    cache_dir = File.join(@ws.prefix_dir, "gems", "vendor", "cache")
    PackageManagers::BundlerManager.run_bundler(
        @ws, "cache"
    )

    FileUtils.mkdir_p(gems_cache_dir) unless File.exist?(gems_cache_dir)

    needs_copy =
        if File.exist?(cache_dir)
            real_cache_dir = File.realpath(cache_dir)
            real_target_dir = File.realpath(gems_cache_dir)
            (real_cache_dir != real_target_dir)
        end

    synchronize_gems_cache_dirs(real_cache_dir, real_target_dir) if needs_copy

    platform_suffix = "-#{Gem::Platform.local}.gem"
    failed = []
    compile.each do |gem_name, artifacts: []|
        Dir.glob(File.join(cache_dir, "#{gem_name}*.gem")) do |gem|
            next if gem.end_with?(platform_suffix)

            gem_basename = File.basename(gem, ".gem")
            expected_platform_gem = File.join(
                real_target_dir, "#{gem_basename}#{platform_suffix}"
            )
            next if !compile_force && File.file?(expected_platform_gem)

            begin
                compile_gem(
                    gem, artifacts: artifacts, output: real_target_dir
                )
            rescue CompilationFailed
                unless keep_going
                    raise CompilationFailed, "#{gem} failed to compile"
                end

                failed << gem
            end
        end
    end

    unless failed.empty?
        raise CompilationFailed, "#{failed.sort.join(', ')} failed to compile"
    end
end

#gems_cache_dir ⇒ Object 



142
143
144
 
# File 'lib/autoproj/ops/cache.rb', line 142

def gems_cache_dir
    File.join(cache_dir, "package_managers", "gem")
end

#git_cache_dir ⇒ Object 



25
26
27
 
# File 'lib/autoproj/ops/cache.rb', line 25

def git_cache_dir
    File.join(cache_dir, "git")
end

#guess_gem_program ⇒ Object

Raises:

  • (ArgumentError) 


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/autoproj/ops/cache.rb', line 209

def guess_gem_program
    return Autobuild.programs["gem"] if Autobuild.programs["gem"]

    ruby_bin = RbConfig::CONFIG["RUBY_INSTALL_NAME"]
    ruby_bindir = RbConfig::CONFIG["bindir"]

    candidates = ["gem"]
    candidates << "gem#{$1}" if ruby_bin =~ /^ruby(.+)$/

    candidates.each do |gem_name|
        if File.file?(gem_full_path = File.join(ruby_bindir, gem_name))
            Autobuild.programs["gem"] = gem_full_path
            return Autobuild.programs["gem"]
        end
    end

    raise ArgumentError,
          "cannot find a gem program (tried "\
          "#{candidates.sort.join(', ')} in #{ruby_bindir})"
end

#synchronize_gems_cache_dirs(source, target) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/autoproj/ops/cache.rb', line 198

def synchronize_gems_cache_dirs(source, target)
    Dir.glob(File.join(source, "*.gem")) do |source_file|
        basename = File.basename(source_file)
        target_file = File.join(target, basename)
        next if File.file?(target_file)

        Autoproj.message "gems: caching #{basename}"
        FileUtils.cp source_file, target_file
    end
end

#with_retry(count) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/autoproj/ops/cache.rb', line 13

def with_retry(count)
    (count + 1).times do |i|
        break yield
    rescue Autobuild::SubcommandFailed
        if i == count
            raise
        else
            Autobuild.message "  failed, retrying (#{i}/#{count})"
        end
    end
end