Class: KnapsackPro::Adapters::BaseAdapter

Inherits:
Object
  • Object
show all
Defined in:
lib/knapsack_pro/adapters/base_adapter.rb

Constant Summary collapse

TEST_DIR_PATTERN =

Just example, please overwrite constant in subclass

'test/**{,/*/**}/*_test.rb'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.adapter_bind_method_called_file ⇒ Object 



9
10
11
12
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 9

def self.adapter_bind_method_called_file
  adapter_name = self.to_s.gsub('::', '-')
  "#{KnapsackPro::Config::TempFiles::TEMP_DIRECTORY_PATH}/#{adapter_name}-bind_method_called_for_node_#{KnapsackPro::Config::Env.ci_node_index}.txt"
end

.bind ⇒ Object 



30
31
32
33
34
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 30

def self.bind
  adapter = new
  adapter.bind
  adapter
end

.slow_test_file?(adapter_class, test_file_path) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 14

def self.slow_test_file?(adapter_class, test_file_path)
  @slow_test_file_paths ||=
    begin
      slow_test_files =
        if KnapsackPro::Config::Env.slow_test_file_pattern
          KnapsackPro::TestFileFinder.slow_test_files_by_pattern(adapter_class)
        else
          # get slow test files from JSON file based on data from API
          KnapsackPro::SlowTestFileDeterminer.read_from_json_report
        end
      KnapsackPro::TestFilePresenter.paths(slow_test_files)
    end
  clean_path = KnapsackPro::TestFileCleaner.clean(test_file_path)
  @slow_test_file_paths.include?(clean_path)
end

.verify_bind_method_called ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 36

def self.verify_bind_method_called
  ::Kernel.at_exit do
    if File.exist?(adapter_bind_method_called_file)
      File.delete(adapter_bind_method_called_file)
    else
      puts "\n\n"
      KnapsackPro.logger.error('-'*10 + ' Configuration error ' + '-'*50)
      KnapsackPro.logger.error("You forgot to call #{self}.bind method in your test runner configuration file. It is needed to record test files time execution. Please follow the installation guide to configure your project properly #{KnapsackPro::Urls::INSTALLATION_GUIDE}")
      KnapsackPro.logger.error("If you already have #{self}.bind method added and you still see this error then one of your tests must have deleted the .knapsack_pro directory from the disk accidentally. Please ensure you do not remove the .knapsack_pro directory: #{KnapsackPro::Urls::DASHBOARD__ZEROISH_TEST_EXECUTION_TIMES}")
      Kernel.exit(1)
    end
  end
end

Instance Method Details

#bind ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 50

def bind
  KnapsackPro::Config::TempFiles.ensure_temp_directory_exists!
  File.write(self.class.adapter_bind_method_called_file, nil)

  if KnapsackPro::Config::Env.recording_enabled?
    KnapsackPro.logger.debug('Test suite time execution recording enabled.')
    bind_time_tracker
    bind_save_report
  end

  if KnapsackPro::Config::Env.queue_recording_enabled?
    KnapsackPro.logger.debug('Test suite time execution queue recording enabled.')
    bind_queue_mode
  end
end

#bind_before_queue_hook ⇒ Object

Raises:

  • (NotImplementedError) 


74
75
76
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 74

def bind_before_queue_hook
  raise NotImplementedError
end

#bind_queue_mode ⇒ Object 



78
79
80
81
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 78

def bind_queue_mode
  bind_before_queue_hook
  bind_time_tracker
end

#bind_save_report ⇒ Object

Raises:

  • (NotImplementedError) 


70
71
72
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 70

def bind_save_report
  raise NotImplementedError
end

#bind_time_tracker ⇒ Object

Raises:

  • (NotImplementedError) 


66
67
68
 
# File 'lib/knapsack_pro/adapters/base_adapter.rb', line 66

def bind_time_tracker
  raise NotImplementedError
end