File: Rakefile

package info (click to toggle)
ruby-mocha 3.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,644 kB
  • sloc: ruby: 12,310; javascript: 499; makefile: 14
file content (171 lines) | stat: -rw-r--r-- 5,330 bytes parent folder | download
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
require 'bundler'
namespace 'rubygems' do
  Bundler::GemHelper.install_tasks
end
require 'bundler/setup'

require 'rake/testtask'
begin
  # Only available with `gemfiles/Gemfile.rubocop`
  require 'rubocop/rake_task'
rescue LoadError
  warn "Unable to load 'rubocop/rake_task', but continuing anyway" if $DEBUG
end

desc 'Run all linters and tests'
task 'default' => ['lint', 'test', 'test:performance']

desc 'Run tests'
task 'test' do
  if (test_library = ENV['MOCHA_RUN_INTEGRATION_TESTS'])
    Rake::Task["test:integration:#{test_library}"].invoke
  else
    Rake::Task['test:units'].invoke
    Rake::Task['test:acceptance'].invoke
  end
end

namespace 'test' do
  desc 'Run unit tests'
  Rake::TestTask.new('units') do |t|
    t.libs << 'test'
    t.test_files = FileList['test/unit/**/*_test.rb']
    t.verbose = true
    t.warning = true
  end

  desc 'Run acceptance tests'
  Rake::TestTask.new('acceptance') do |t|
    t.libs << 'test'
    t.test_files = FileList['test/acceptance/*_test.rb']
    t.verbose = true
    t.warning = true
  end

  namespace 'integration' do
    desc 'Run Minitest integration tests (intended to be run in its own process)'
    Rake::TestTask.new('minitest') do |t|
      t.libs << 'test'
      t.test_files = FileList['test/integration/minitest_test.rb']
      t.verbose = true
      t.warning = true
    end

    desc 'Run Test::Unit integration tests (intended to be run in its own process)'
    Rake::TestTask.new('test-unit') do |t|
      t.libs << 'test'
      t.test_files = FileList['test/integration/test_unit_test.rb']
      t.verbose = true
      t.warning = true
    end
  end

  # require 'rcov/rcovtask'
  # Rcov::RcovTask.new('coverage') do |t|
  #   t.libs << 'test'
  #   t.test_files = unit_tests + acceptance_tests
  #   t.verbose = true
  #   t.warning = true
  #   t.rcov_opts << '--sort coverage'
  #   t.rcov_opts << '--xref'
  # end

  desc 'Run performance tests'
  task 'performance' do
    require File.join(File.dirname(__FILE__), 'test', 'acceptance', 'stubba_example_test')
    require File.join(File.dirname(__FILE__), 'test', 'acceptance', 'mocha_example_test')
    iterations = 1000
    puts "\nBenchmarking with #{iterations} iterations..."
    [MochaExampleTest, StubbaExampleTest].each do |test_case|
      puts "#{test_case}: #{benchmark_test_case(test_case, iterations)} seconds."
    end
  end
end

desc 'Run linters'
task 'lint' do
  if defined?(RuboCop::RakeTask)
    RuboCop::RakeTask.new
    Rake::Task['rubocop'].invoke
  else
    puts 'RuboCop not available - skipping linting'
  end
end

def benchmark_test_case(klass, iterations)
  require 'benchmark'
  require 'mocha/detection/minitest'

  if defined?(Minitest)
    minitest_version = Gem::Version.new(Mocha::Detection::Minitest.version)
    if Gem::Requirement.new('>= 5.0.0').satisfied_by?(minitest_version)
      Minitest.seed = 1
      result = Benchmark.realtime { iterations.times { |_i| klass.run(Minitest::CompositeReporter.new) } }
      Minitest::Runnable.runnables.delete(klass)
      result
    else
      Minitest::Unit.output = StringIO.new
      Benchmark.realtime { iterations.times { |_i| Minitest::Unit.new.run([klass]) } }
    end
  else
    load 'test/unit/ui/console/testrunner.rb' unless defined?(Test::Unit::UI::Console::TestRunner)
    unless @silent_option
      begin
        load 'test/unit/ui/console/outputlevel.rb' unless defined?(Test::Unit::UI::Console::OutputLevel::SILENT)
        @silent_option = { output_level: Test::Unit::UI::Console::OutputLevel::SILENT }
      rescue LoadError
        @silent_option = Test::Unit::UI::SILENT
      end
    end
    Benchmark.realtime { iterations.times { Test::Unit::UI::Console::TestRunner.run(klass, @silent_option) } }
  end
end
if ENV['MOCHA_GENERATE_DOCS']
  require 'yard'

  namespace :docs do
    desc 'Remove generated documentation'
    task :clobber do
      `rm -rf ./docs`
    end

    desc 'Generate documentation'
    YARD::Rake::YardocTask.new(:generate) do |task|
      task.options = ['--title', "Mocha #{Mocha::VERSION}", '--fail-on-warning']
    end

    desc 'Ensure custom domain remains in place for docs on GitHub Pages'
    task :ensure_cname do
      `git checkout docs/CNAME`
    end

    desc 'Ensure custom JavaScript files remain in place for docs on GitHub Pages'
    task :ensure_js do
      `git checkout docs/js/app.js`
      `git checkout docs/js/jquery.js`
    end

    desc 'Check documentation coverage'
    task :coverage do
      stats_output = `yard stats --list-undoc`
      puts stats_output

      match = stats_output.match(/(?<coverage_percentage>\d+\.\d+)% documented/);
      abort 'Error: Could not determine documentation coverage.' unless match

      coverage_percentage = match[:coverage_percentage].to_f
      minimum_percentage = 100.0

      if coverage_percentage < minimum_percentage
        abort "Documentation coverage is #{coverage_percentage}%, which is below the required #{minimum_percentage}%."
      else
        puts "Documentation coverage is #{coverage_percentage}%, which is at or above the required #{minimum_percentage}%."
      end
    end
  end

  desc 'Prepare documentation for publication on GitHub Pages'
  task 'docs' => %w[docs:clobber docs:generate docs:ensure_cname docs:ensure_js]
end

task 'release' => ['default', 'rubygems:release']