apps/workbench/test/integration/pipeline_instances_test.rb

   1 require 'integration_helper'
   2
   3 class PipelineInstancesTest < ActionDispatch::IntegrationTest
   4   setup do
   5     need_javascript
   6   end
   7
   8   test 'Create and run a pipeline' do
   9     visit page_with_token('active_trustedclient')
  10
  11     visit '/pipeline_templates'
  12     within('tr', text: 'Two Part Pipeline Template') do
  13       find('a,button', text: 'Run').click
  14     end
  15
  16     # project chooser
  17     within('.modal-dialog') do
  18       find('.selectable', text: 'A Project').click
  19       find('button', text: 'Choose').click
  20     end
  21
  22     # This pipeline needs input. So, Run should be disabled
  23     page.assert_selector 'a.disabled,button.disabled', text: 'Run'
  24
  25     instance_page = current_path
  26
  27     # Add this collection to the project
  28     visit '/projects'
  29     find("#projects-menu").click
  30     find('.dropdown-menu a,button', text: 'A Project').click
  31     find('.btn', text: 'Add data').click
  32     find('.dropdown-menu a,button', text: 'Copy data from another project').click
  33     within('.modal-dialog') do
  34       wait_for_ajax
  35       first('span', text: 'foo_tag').click
  36       find('.btn', text: 'Copy').click
  37     end
  38     using_wait_time(Capybara.default_wait_time * 3) do
  39       wait_for_ajax
  40     end
  41
  42     click_link 'Jobs and pipelines'
  43     find('tr[data-kind="arvados#pipelineInstance"]', text: '(none)').
  44       find('a', text: 'Show').
  45       click
  46
  47     assert find('p', text: 'Provide a value')
  48
  49     find('div.form-group', text: 'Foo/bar pair').
  50       find('.btn', text: 'Choose').
  51       click
  52
  53     within('.modal-dialog') do
  54       assert(has_text?("Foo/bar pair"),
  55              "pipeline input picker missing name of input")
  56       wait_for_ajax
  57       first('span', text: 'foo_tag').click
  58       find('button', text: 'OK').click
  59     end
  60     wait_for_ajax
  61
  62     # The input, after being specified, should still be displayed (#3382)
  63     assert find('div.form-group', text: 'Foo/bar pair')
  64
  65     # The input, after being specified, should still be editable (#3382)
  66     find('div.form-group', text: 'Foo/bar pair').
  67       find('.btn', text: 'Choose').click
  68
  69     within('.modal-dialog') do
  70       assert(has_text?("Foo/bar pair"),
  71              "pipeline input picker missing name of input")
  72       wait_for_ajax
  73       first('span', text: 'foo_tag').click
  74       find('button', text: 'OK').click
  75     end
  76
  77     # For good measure, check one last time that the input, after being specified twice, is still be displayed (#3382)
  78     assert find('div.form-group', text: 'Foo/bar pair')
  79
  80     # Ensure that the collection's portable_data_hash, uuid and name
  81     # are saved in the desired places. (#4015)
  82
  83     # foo_collection_in_aproject is the collection tagged with foo_tag.
  84     collection = api_fixture('collections', 'foo_collection_in_aproject')
  85     click_link 'Advanced'
  86     click_link 'API response'
  87     api_response = JSON.parse(find('div#advanced_api_response pre').text)
  88     input_params = api_response['components']['part-one']['script_parameters']['input']
  89     assert_equal input_params['value'], collection['portable_data_hash']
  90     assert_equal input_params['selection_name'], collection['name']
  91     assert_equal input_params['selection_uuid'], collection['uuid']
  92
  93     # "Run" button is now enabled
  94     page.assert_no_selector 'a.disabled,button.disabled', text: 'Run'
  95
  96     first('a,button', text: 'Run').click
  97
  98     # Pipeline is running. We have a "Pause" button instead now.
  99     page.assert_selector 'a,button', text: 'Pause'
 100     find('a,button', text: 'Pause').click
 101
 102     # Pipeline is stopped. It should now be in paused state and Runnable again.
 103     assert page.has_text? 'Paused'
 104     page.assert_no_selector 'a.disabled,button.disabled', text: 'Resume'
 105     page.assert_selector 'a,button', text: 'Re-run with latest'
 106     page.assert_selector 'a,button', text: 'Re-run options'
 107
 108     # Since it is test env, no jobs are created to run. So, graph not visible
 109     assert_not page.has_text? 'Graph'
 110   end
 111
 112   # Create a pipeline instance from within a project and run
 113   test 'Create pipeline inside a project and run' do
 114     visit page_with_token('active_trustedclient')
 115
 116     # Add this collection to the project using collections menu from top nav
 117     visit '/projects'
 118     find("#projects-menu").click
 119     find('.dropdown-menu a,button', text: 'A Project').click
 120     find('.btn', text: 'Add data').click
 121     find('.dropdown-menu a,button', text: 'Copy data from another project').click
 122     within('.modal-dialog') do
 123       wait_for_ajax
 124       first('span', text: 'foo_tag').click
 125       find('.btn', text: 'Copy').click
 126     end
 127     using_wait_time(Capybara.default_wait_time * 3) do
 128       wait_for_ajax
 129     end
 130
 131     create_and_run_pipeline_in_aproject true, 'Two Part Pipeline Template', 'foo_collection_in_aproject', false
 132   end
 133
 134   # Create a pipeline instance from outside of a project
 135   test 'Run a pipeline from dashboard' do
 136     visit page_with_token('active_trustedclient')
 137     create_and_run_pipeline_in_aproject false, 'Two Part Pipeline Template', 'foo_collection_in_aproject', false
 138   end
 139
 140   test 'view pipeline with job and see graph' do
 141     visit page_with_token('active_trustedclient')
 142
 143     visit '/pipeline_instances'
 144     assert page.has_text? 'pipeline_with_job'
 145
 146     find('a', text: 'pipeline_with_job').click
 147
 148     # since the pipeline component has a job, expect to see the graph
 149     assert page.has_text? 'Graph'
 150     click_link 'Graph'
 151     page.assert_selector "#provenance_graph"
 152   end
 153
 154   test 'pipeline description' do
 155     visit page_with_token('active_trustedclient')
 156
 157     visit '/pipeline_instances'
 158     assert page.has_text? 'pipeline_with_job'
 159
 160     find('a', text: 'pipeline_with_job').click
 161
 162     within('.arv-description-as-subtitle') do
 163       find('.fa-pencil').click
 164       find('.editable-input textarea').set('*Textile description for pipeline instance*')
 165       find('.editable-submit').click
 166     end
 167     wait_for_ajax
 168
 169     # verify description
 170     assert page.has_no_text? '*Textile description for pipeline instance*'
 171     assert page.has_text? 'Textile description for pipeline instance'
 172   end
 173
 174   test "JSON popup available for strange components" do
 175     uuid = api_fixture("pipeline_instances")["components_is_jobspec"]["uuid"]
 176     visit page_with_token("active", "/pipeline_instances/#{uuid}")
 177     click_on "Components"
 178     assert(page.has_no_text?("script_parameters"),
 179            "components JSON visible without popup")
 180     click_on "Show components JSON"
 181     assert(page.has_text?("script_parameters"),
 182            "components JSON not found")
 183   end
 184
 185   PROJECT_WITH_SEARCH_COLLECTION = "A Subproject"
 186   def check_parameter_search(proj_name)
 187     template = api_fixture("pipeline_templates")["parameter_with_search"]
 188     search_text = template["components"]["with-search"]["script_parameters"]["input"]["search_for"]
 189     visit page_with_token("active", "/pipeline_templates/#{template['uuid']}")
 190     click_on "Run this pipeline"
 191     within(".modal-dialog") do  # Set project for the new pipeline instance
 192       find(".selectable", text: proj_name).click
 193       click_on "Choose"
 194     end
 195     assert(has_text?("This pipeline was created from the template"), "did not land on pipeline instance page")
 196     first("a.btn,button", text: "Choose").click
 197     within(".modal-body") do
 198       if (proj_name != PROJECT_WITH_SEARCH_COLLECTION)
 199         # Switch finder modal to Subproject to find the Collection.
 200         click_on proj_name
 201         click_on PROJECT_WITH_SEARCH_COLLECTION
 202       end
 203       assert_equal(search_text, first("input").value,
 204                    "parameter search not preseeded")
 205       assert(has_text?(api_fixture("collections")["baz_collection_name_in_asubproject"]["name"]),
 206              "baz Collection not in preseeded search results")
 207     end
 208   end
 209
 210   test "Workbench respects search_for parameter in templates" do
 211     check_parameter_search(PROJECT_WITH_SEARCH_COLLECTION)
 212   end
 213
 214   test "Workbench preserves search_for parameter after project switch" do
 215     check_parameter_search("A Project")
 216   end
 217
 218   [
 219     [true, 'Two Part Pipeline Template', 'foo_collection_in_aproject', false],
 220     [false, 'Two Part Pipeline Template', 'foo_collection_in_aproject', false],
 221     [true, 'Two Part Template with dataclass File', 'foo_collection_in_aproject', true],
 222     [false, 'Two Part Template with dataclass File', 'foo_collection_in_aproject', true],
 223     [true, 'Two Part Pipeline Template', 'collection_with_no_name_in_aproject', false],
 224   ].each do |in_aproject, template_name, collection, choose_file|
 225     test "Run pipeline instance in #{in_aproject} with #{template_name} with #{collection} file #{choose_file}" do
 226       if in_aproject
 227         visit page_with_token 'active', \
 228         '/projects/'+api_fixture('groups')['aproject']['uuid']
 229       else
 230         visit page_with_token 'active', '/'
 231       end
 232
 233       # need bigger modal size when choosing a file from collection
 234       if Capybara.current_driver == :selenium
 235         Capybara.current_session.driver.browser.manage.window.resize_to(1200, 800)
 236       end
 237
 238       create_and_run_pipeline_in_aproject in_aproject, template_name, collection, choose_file
 239       instance_path = current_path
 240
 241       # Pause the pipeline
 242       find('a,button', text: 'Pause').click
 243       assert page.has_text? 'Paused'
 244       page.assert_no_selector 'a.disabled,button.disabled', text: 'Resume'
 245       page.assert_selector 'a,button', text: 'Re-run with latest'
 246       page.assert_selector 'a,button', text: 'Re-run options'
 247
 248       # Verify that the newly created instance is created in the right project.
 249       assert page.has_text? 'Home'
 250       if in_aproject
 251         assert page.has_text? 'A Project'
 252       else
 253         assert page.has_no_text? 'A Project'
 254       end
 255     end
 256   end
 257
 258   [
 259     ['active', false, false, false],
 260     ['active', false, false, true],
 261     ['active', true, false, false],
 262     ['active', true, true, false],
 263     ['active', true, false, true],
 264     ['active', true, true, true],
 265     ['project_viewer', false, false, true],
 266     ['project_viewer', true, true, true],
 267   ].each do |user, with_options, choose_options, in_aproject|
 268     test "Rerun pipeline instance as #{user} using options #{with_options} #{choose_options} in #{in_aproject}" do
 269       if in_aproject
 270         visit page_with_token 'active', \
 271         '/projects/'+api_fixture('groups')['aproject']['uuid']
 272       else
 273         visit page_with_token 'active', '/'
 274       end
 275
 276       # need bigger modal size when choosing a file from collection
 277       if Capybara.current_driver == :selenium
 278         Capybara.current_session.driver.browser.manage.window.resize_to(1200, 800)
 279       end
 280
 281       create_and_run_pipeline_in_aproject in_aproject, 'Two Part Pipeline Template', 'foo_collection_in_aproject'
 282       instance_path = current_path
 283
 284       # Pause the pipeline
 285       find('a,button', text: 'Pause').click
 286       assert page.has_text? 'Paused'
 287       page.assert_no_selector 'a.disabled,button.disabled', text: 'Resume'
 288       page.assert_selector 'a,button', text: 'Re-run with latest'
 289       page.assert_selector 'a,button', text: 'Re-run options'
 290
 291       # Pipeline can be re-run now. Access it as the specified user, and re-run
 292       if user == 'project_viewer'
 293         visit page_with_token(user, instance_path)
 294         assert page.has_text? 'A Project'
 295         page.assert_no_selector 'a.disabled,button.disabled', text: 'Resume'
 296         page.assert_selector 'a,button', text: 'Re-run with latest'
 297         page.assert_selector 'a,button', text: 'Re-run options'
 298       end
 299
 300       # Now re-run the pipeline
 301       if with_options
 302         assert_triggers_dom_event 'shown.bs.modal' do
 303           find('a,button', text: 'Re-run options').click
 304         end
 305         within('.modal-dialog') do
 306           page.assert_selector 'a,button', text: 'Copy and edit inputs'
 307           page.assert_selector 'a,button', text: 'Run now'
 308           if choose_options
 309             find('button', text: 'Copy and edit inputs').click
 310           else
 311             find('button', text: 'Run now').click
 312           end
 313         end
 314       else
 315         find('a,button', text: 'Re-run with latest').click
 316       end
 317
 318       # Verify that the newly created instance is created in the right
 319       # project. In case of project_viewer user, since the user cannot
 320       # write to the project, the pipeline should have been created in
 321       # the user's Home project.
 322       assert_not_equal instance_path, current_path, 'Rerun instance path expected to be different'
 323       assert_text 'Home'
 324       if in_aproject && (user != 'project_viewer')
 325         assert_text 'A Project'
 326       else
 327         assert_no_text 'A Project'
 328       end
 329     end
 330   end
 331
 332   # Create and run a pipeline for 'Two Part Pipeline Template' in 'A Project'
 333   def create_and_run_pipeline_in_aproject in_aproject, template_name, collection_fixture, choose_file=false
 334     # collection in aproject to be used as input
 335     collection = api_fixture('collections', collection_fixture)
 336
 337     # create a pipeline instance
 338     find('.btn', text: 'Run a pipeline').click
 339     within('.modal-dialog') do
 340       find('.selectable', text: template_name).click
 341       find('.btn', text: 'Next: choose inputs').click
 342     end
 343
 344     assert find('p', text: 'Provide a value')
 345
 346     find('div.form-group', text: 'Foo/bar pair').
 347       find('.btn', text: 'Choose').
 348       click
 349
 350     within('.modal-dialog') do
 351       if in_aproject
 352         assert_selector 'button.dropdown-toggle', text: 'A Project'
 353         wait_for_ajax
 354       else
 355         assert_selector 'button.dropdown-toggle', text: 'Home'
 356         wait_for_ajax
 357         click_button "Home"
 358         click_link "A Project"
 359         wait_for_ajax
 360       end
 361
 362       if collection_fixture == 'foo_collection_in_aproject'
 363         first('span', text: 'foo_tag').click
 364       elsif collection['name']
 365         first('span', text: "#{collection['name']}").click
 366       else
 367         collection_uuid = collection['uuid']
 368         find("div[data-object-uuid=#{collection_uuid}]").click
 369       end
 370
 371       if choose_file
 372         wait_for_ajax
 373         find('.preview-selectable', text: 'foo').click
 374       end
 375       find('button', text: 'OK').click
 376     end
 377
 378     # The input, after being specified, should still be displayed (#3382)
 379     assert find('div.form-group', text: 'Foo/bar pair')
 380
 381     # Ensure that the collection's portable_data_hash, uuid and name
 382     # are saved in the desired places. (#4015)
 383     click_link 'Advanced'
 384     click_link 'API response'
 385
 386     api_response = JSON.parse(find('div#advanced_api_response pre').text)
 387     input_params = api_response['components']['part-one']['script_parameters']['input']
 388     assert_equal(input_params['selection_uuid'], collection['uuid'], "Not found expected input param uuid")
 389     if choose_file
 390       assert_equal(input_params['value'], collection['portable_data_hash']+'/foo', "Not found expected input file param value")
 391       assert_equal(input_params['selection_name'], collection['name']+'/foo', "Not found expected input file param name")
 392     else
 393       assert_equal(input_params['value'], collection['portable_data_hash'], "Not found expected input param value")
 394       assert_equal(input_params['selection_name'], collection['name'], "Not found expected input selection name")
 395     end
 396
 397     # "Run" button present and enabled
 398     page.assert_no_selector 'a.disabled,button.disabled', text: 'Run'
 399     first('a,button', text: 'Run').click
 400
 401     # Pipeline is running. We have a "Pause" button instead now.
 402     page.assert_no_selector 'a,button', text: 'Run'
 403     page.assert_no_selector 'a.disabled,button.disabled', text: 'Resume'
 404     page.assert_selector 'a,button', text: 'Pause'
 405
 406     # Since it is test env, no jobs are created to run. So, graph not visible
 407     assert_not page.has_text? 'Graph'
 408   end
 409
 410   [
 411     [1, 0], # run time 0 minutes
 412     [10, 17*60*60 + 51*60], # run time 17 hours and 51 minutes
 413   ].each do |index, run_time|
 414     test "pipeline start and finish time display #{index}" do
 415       visit page_with_token("user1_with_load", "/pipeline_instances/zzzzz-d1hrv-10pipelines0#{index.to_s.rjust(3, '0')}")
 416
 417       assert page.has_text? 'This pipeline started at'
 418       page_text = page.text
 419
 420       match = /This pipeline started at (.*)\. It failed after (.*) seconds at (.*)\. Check the Log/.match page_text
 421       assert_not_nil(match, 'Did not find text - This pipeline started at . . . ')
 422
 423       start_at = match[1]
 424       finished_at = match[3]
 425       assert_not_nil(start_at, 'Did not find start_at time')
 426       assert_not_nil(finished_at, 'Did not find finished_at time')
 427
 428       # start and finished time display is of the format '2:20 PM 10/20/2014'
 429       start_time = DateTime.strptime(start_at, '%H:%M %p %m/%d/%Y').to_time
 430       finished_time = DateTime.strptime(finished_at, '%H:%M %p %m/%d/%Y').to_time
 431       assert_equal(run_time, finished_time-start_time,
 432         "Time difference did not match for start_at #{start_at}, finished_at #{finished_at}, ran_for #{match[2]}")
 433     end
 434   end
 435
 436   [
 437     ['fuse', nil, 2, 20],                           # has 2 as of 11-07-2014
 438     ['fuse', 'FUSE project', 1, 1],                 # 1 with this name
 439     ['user1_with_load', nil, 30, 100],              # has 37 as of 11-07-2014
 440     ['user1_with_load', 'pipeline_10', 2, 2],       # 2 with this name
 441     ['user1_with_load', '000010pipelines', 10, 10], # owned_by the project zzzzz-j7d0g-000010pipelines
 442     ['user1_with_load', '000025pipelines', 25, 25], # owned_by the project zzzzz-j7d0g-000025pipelines, two pages
 443     ['admin', nil, 40, 200],
 444     ['admin', 'FUSE project', 1, 1],
 445     ['admin', 'pipeline_10', 2, 2],
 446     ['active', 'containing at least two', 2, 100],    # component description
 447     ['active', nil, 10, 100],
 448     ['active', 'no such match', 0, 0],
 449   ].each do |user, search_filter, expected_min, expected_max|
 450     test "scroll pipeline instances page for #{user} with search filter #{search_filter}
 451           and expect #{expected_min} <= found_items <= #{expected_max}" do
 452       visit page_with_token(user, "/pipeline_instances")
 453
 454       if search_filter
 455         find('.recent-pipeline-instances-filterable-control').set(search_filter)
 456         # Wait for 250ms debounce timer (see filterable.js)
 457         sleep 0.350
 458         wait_for_ajax
 459       end
 460
 461       page_scrolls = expected_max/20 + 2    # scroll num_pages+2 times to test scrolling is disabled when it should be
 462       within('.arv-recent-pipeline-instances') do
 463         (0..page_scrolls).each do |i|
 464           page.driver.scroll_to 0, 999000
 465           begin
 466             wait_for_ajax
 467           rescue
 468           end
 469         end
 470       end
 471
 472       # Verify that expected number of pipeline instances are found
 473       found_items = page.all('tr[data-kind="arvados#pipelineInstance"]')
 474       found_count = found_items.count
 475       if expected_min == expected_max
 476         assert_equal(true, found_count == expected_min,
 477           "Not found expected number of items. Expected #{expected_min} and found #{found_count}")
 478         assert page.has_no_text? 'request failed'
 479       else
 480         assert_equal(true, found_count>=expected_min,
 481           "Found too few items. Expected at least #{expected_min} and found #{found_count}")
 482         assert_equal(true, found_count<=expected_max,
 483           "Found too many items. Expected at most #{expected_max} and found #{found_count}")
 484       end
 485     end
 486   end
 487
 488 end