Class: Homebrew::TestBot::Test Private

Inherits:
Object
  • Object
show all
Includes:
Utils::Output::Mixin
Defined in:
test_bot/test.rb

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Direct Known Subclasses

FormulaeDetect, Setup, TapSyntax, TestCleanup, TestFormulae

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_unmarked, #pretty_upgradable, #pretty_warning

Instance Attribute Details

#steps ⇒ Array<Step> (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



23
24
25
 
# File 'test_bot/test.rb', line 23

def steps
  @steps
end

Instance Method Details

#failed_steps ⇒ Array<Step>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



13
14
15
 
# File 'test_bot/test.rb', line 13

def failed_steps
  @steps.select(&:failed?)
end

#ignored_steps ⇒ Array<Step>

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



18
19
20
 
# File 'test_bot/test.rb', line 18

def ignored_steps
  @steps.select(&:ignored?)
end

#test(*arguments, named_args: nil, env: {}, verbose: @verbose, ignore_failures: false, report_analytics: false) ⇒ Step

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

  • arguments (String, Pathname)
  • named_args (String, Array<String>, nil) (defaults to: nil)
  • env (Hash{String => String, Boolean, PATH, nil}) (defaults to: {})
  • verbose (Boolean) (defaults to: @verbose)
  • ignore_failures (Boolean) (defaults to: false)
  • report_analytics (Boolean) (defaults to: false)

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'test_bot/test.rb', line 35

def test(*arguments, named_args: nil, env: {}, verbose: @verbose, ignore_failures: false,
         report_analytics: false)
  step = Step.new(
    arguments.map(&:to_s),
    named_args:,
    env:,
    verbose:,
    ignore_failures:,
    repository:      @repository,
  )
  step.run(dry_run: @dry_run, fail_fast: @fail_fast)
  @steps << step

  if ENV["HOMEBREW_TEST_BOT_ANALYTICS"].present? && report_analytics
    ::Utils::Analytics.report_test_bot_test(step.command_short, step.passed?)
  end

  step
end