File: generator.rb

package info (click to toggle)
ruby-rr 3.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,424 kB
  • sloc: ruby: 11,405; makefile: 7
file content (348 lines) | stat: -rw-r--r-- 9,132 bytes parent folder | download | duplicates (5)
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
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
141
142
143
144
145
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
require File.expand_path('../../generator', __FILE__)
require File.expand_path('../../test_file/generator', __FILE__)
require File.expand_path('../../test_helper/generator', __FILE__)
require File.expand_path('../../command_runner', __FILE__)
require File.expand_path('../tests_runner', __FILE__)

require 'tempfile'

module Project
  class Generator
    include ::Generator

    attr_accessor \
      :autorequire_gems,
      :include_rr_before_test_framework

    attr_reader \
      :gem_dependencies,
      :test_requires,
      :prelude

    def setup
      super
      self.autorequire_gems = false
      self.include_rr_before_test_framework = false
      @gem_dependencies = []
      @test_requires = []
      @number_of_test_files = 0
      @prelude = ""
      @files_to_add = []
    end

    def root_dir
      File.expand_path('../../../..', __FILE__)
    end

    def lib_dir
      File.join(root_dir, 'lib')
    end

    def directory
      File.join(root_dir, 'tmp', 'rr-integration-tests', 'test_project')
    end

    def bundle_dir
      File.join(directory, '.bundle')
    end

    def test_filename
      raise NotImplementedError
    end

    def test_runner_command
      raise NotImplementedError
    end

    def call
      FileUtils.rm_rf directory
      FileUtils.mkdir_p File.dirname(directory)
      generate_skeleton
      test_helper_generator.call(self)
    end

    def add_to_prelude(string)
      test_helper_generator.configure do |file|
        file.add_to_prelude(string)
      end
    end

    def add_to_test_requires(path)
      test_helper_generator.configure do |file|
        file.add_to_requires(path)
      end
    end

    def add_test_file(&block)
      test_file_generator.call(self, @number_of_test_files, &block)
      @number_of_test_files += 1
    end

    def run_tests
      TestsRunner.call(self)
    end

    def declare_and_install_gems
      declare_gems_within_gemfile
      install_gems_via_bundler
    end

    def declare_gems_within_gemfile
      append_to_file 'Gemfile', "\n\n#{build_gem_list}"
    end

    def install_gems_via_bundler
      # XXX: This will fail if some gems are not available!
      #if RR.debug?
      #  run_command! "#{bundle_executable} env"
      #end

      run_command! ruby_command('bundle check || bundle install')
    end

    def within(&block)
      ret = nil
      Dir.chdir(directory) { ret = block.call }
      ret
    end

    def exec(command)
      CommandRunner.call(command)
    end

    def exec!(command)
      result = exec(command)
      if not result.success?
        raise "Command failed: #{command}"
      end
      result
    end

    def run_command(command, opts={})
      f = Tempfile.new('rr-integration-test-file')
      contents = ""
      unless opts[:without_bundler_sandbox]
        # Bundler will set RUBYOPT to "-I <path to bundler> -r bundler/setup".
        # This is unfortunate as it causes Bundler to be loaded before we
        # load Bundler in RR::Test.setup_test_suite, thereby rendering our
        # second Bundler.setup a no-op.
        contents << <<-EOT
          export BUNDLE_BIN_PATH=""
          export BUNDLE_GEMFILE=""
          export RUBYOPT=""
        EOT
      end
      if opts[:env]
        opts[:env].split(' ').each do |pair|
          contents << "export #{pair}\n"
        end
      end
      contents << <<-EOT
        #{format_command(command)}
        exit $?
      EOT
      if RR.debug?
        puts "~ File to run ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        puts contents
        puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
      end
      f.write(contents)
      f.close
      exec("bash #{f.path}")
    ensure
      f.unlink if f
    end

    def run_command!(command, opts={})
      result = run_command(command, opts)
      if not result.success?
        raise "Command failed: #{command}"
      end
      result
    end

    def run_command_within(command, opts={})
      within { run_command(command, opts) }
    end

    def run_command_within!(command, opts={})
      within { run_command!(command, opts) }
    end

    def format_command(command)
      if command =~ /^bundle/
        command
      else
        "bundle exec #{command}"
      end
    end

    def add_file(file_name, content)
      @files_to_add << [file_name, content]
    end

    def build_gem_list
      gem_dependencies_with_rr.
        map { |dep| gem_dependency_line(dep) }.
        join("\n")
    end

    def test_file_generator
      @test_file_generator ||= TestFile::Generator.factory
    end

    def requires_with_rr(requires)
      requires = requires.dup
      unless autorequire_gems
        if include_rr_before_test_framework
          requires.unshift 'rr'
        else
          requires.push 'rr'
        end
      end
      requires
    end

    def require_lines(requires)
      requires.map { |path| "require '#{path}'" }
    end

    def test_helper_generator
      @test_helper_generator ||= TestHelper::Generator.factory
    end

    private

    def generate_skeleton
    end

    def create_files
      @files_to_add.each do |file_name, content|
        full_file_name = File.join(directory, file_name)
        FileUtils.mkdir_p File.dirname(full_file_name)
        create_file full_file_name, content
      end
    end

    def create_link(filename, dest_filename = filename)
      FileUtils.ln_sf(File.join(root_dir, filename), File.join(directory, dest_filename))
    end

    def copy_file(filename, dest_filename = filename)
      FileUtils.cp(File.join(root_dir, filename), File.join(directory, dest_filename))
    end

    def create_file(filename, content, opts={})
      File.open(filename, 'w') do |f|
        if RR.debug? && !opts[:without_debug]
          puts "~ Adding file #{filename} ~~~~~~~~~~~~~~~~~~~~~~~~"
          puts content
          puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        end
        f.write(content)
      end
    end

    def replace_in_file(filename, search, replace)
      content = File.read(filename)
      content.sub!(search, replace)
      File.open(filename, 'w') { |f| f.write(content) }

      if RR.debug?
        puts "~ #{filename} is now: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        puts File.read(filename)
        puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
      end
    end

    def append_to_file(filename, additional_content)
      content = File.read(filename)
      File.open(filename, 'w') do |f|
        f.write(content + additional_content)
      end

      if RR.debug?
        puts "~ #{filename} is now: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        puts File.read(filename)
        puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
      end
    end

    def prepend_to_file(filename, additional_content)
      content = File.read(filename)
      File.open(filename, 'w') do |f|
        f.write(additional_content + content)
      end

      if RR.debug?
        puts "~ #{filename} is now: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        puts File.read(filename)
        puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
      end
    end

    def add_in_file_before(filename, search, additional_content)
      content = File.read(filename)
      content.insert(content.index(search), additional_content)
      File.open(filename, 'w') { |f| f.write(content) }

      if RR.debug?
        puts "~ #{filename} is now: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        puts File.read(filename)
        puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
      end
    end

    def add_in_file_after(filename, search, additional_content)
      content = File.read(filename)
      content.insert(content.index(search) + search.length, additional_content)
      File.open(filename, 'w') { |f| f.write(content) }

      if RR.debug?
        puts "~ #{filename} is now: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
        puts File.read(filename)
        puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
      end
    end

    def under_jruby?
      RUBY_PLATFORM =~ /java/
    end

    def gem_dependency(dep)
      dep
    end

    def gem_dependency_line(dep)
      dep = dep.dup
      name = dep.delete(:name)
      version = dep.delete(:version)
      "gem #{name.to_s.inspect}, #{version.inspect}, #{dep.inspect}"
    end

    def gem_dependencies_with_rr
      if RR.debug?
        puts "Include RR before test framework? #{include_rr_before_test_framework.inspect}"
        puts "Autorequiring gems? #{autorequire_gems.inspect}"
      end

      dependencies = gem_dependencies.dup

      rr_dep = {:name => 'rr', :path => root_dir, :version => RR.version}
      rr_dep[:require] = false unless autorequire_gems
      rr_dep = gem_dependency(rr_dep)

      if include_rr_before_test_framework
        dependencies.unshift(rr_dep)
      else
        dependencies.push(rr_dep)
      end

      dependencies
    end

    def ruby_command(command)
      command
    end
  end
end