Merge branch '4535-configure-api-host-url' closes #4535
[arvados.git] / apps / workbench / test / functional / collections_controller_test.rb
index f86c50a26788a92a352700808afe752b635ab25d..6c64ac901cb113564c17f9122453485c0cfeab7d 100644 (file)
@@ -3,6 +3,15 @@ require 'test_helper'
 class CollectionsControllerTest < ActionController::TestCase
   NONEXISTENT_COLLECTION = "ffffffffffffffffffffffffffffffff+0"
 
+  def stub_file_content
+    # For the duration of the current test case, stub file download
+    # content with a randomized (but recognizable) string. Return the
+    # string, the test case can use it in assertions.
+    txt = 'the quick brown fox ' + rand(2**32).to_s
+    @controller.stubs(:file_enumerator).returns([txt])
+    txt
+  end
+
   def collection_params(collection_name, file_name=nil)
     uuid = api_fixture('collections')[collection_name.to_s]['uuid']
     params = {uuid: uuid, id: uuid}
@@ -10,13 +19,6 @@ class CollectionsControllerTest < ActionController::TestCase
     params
   end
 
-  def expected_contents(params, token)
-    unless token.is_a? String
-      token = params[:api_token] || token[:arvados_api_token]
-    end
-    [token, params[:uuid], params[:file]].join('/')
-  end
-
   def assert_hash_includes(actual_hash, expected_hash, msg=nil)
     expected_hash.each do |key, value|
       assert_equal(value, actual_hash[key], msg)
@@ -42,22 +44,14 @@ class CollectionsControllerTest < ActionController::TestCase
     assert_response response
   end
 
-  # Mock the collection file reader to avoid external calls and return
-  # a predictable string.
-  CollectionsController.class_eval do
-    def file_enumerator(opts)
-      [[opts[:arvados_api_token], opts[:uuid], opts[:file]].join('/')]
-    end
-  end
-
   test "viewing a collection" do
     show_collection(:foo_file, :active)
     assert_equal([['.', 'foo', 3]], assigns(:object).files)
   end
 
   test "viewing a collection fetches related projects" do
-    show_collection(:foo_file, :active)
-    assert_includes(assigns(:projects).map(&:uuid),
+    show_collection({id: api_fixture('collections')["foo_file"]['portable_data_hash']}, :active)
+    assert_includes(assigns(:same_pdh).map(&:owner_uuid),
                     api_fixture('groups')['aproject']['uuid'],
                     "controller did not find linked project")
   end
@@ -92,18 +86,30 @@ class CollectionsControllerTest < ActionController::TestCase
 
   test "viewing collection files with a reader token" do
     params = collection_params(:foo_file)
-    params[:reader_token] =
-      api_fixture('api_client_authorizations')['active']['api_token']
+    params[:reader_token] = api_fixture("api_client_authorizations",
+                                        "active_all_collections", "api_token")
     get(:show_file_links, params)
     assert_response :success
     assert_equal([['.', 'foo', 3]], assigns(:object).files)
     assert_no_session
   end
 
+  test "fetching collection file with reader token" do
+    expected = stub_file_content
+    params = collection_params(:foo_file, "foo")
+    params[:reader_token] = api_fixture("api_client_authorizations",
+                                        "active_all_collections", "api_token")
+    get(:show_file, params)
+    assert_response :success
+    assert_equal(expected, @response.body,
+                 "failed to fetch a Collection file with a reader token")
+    assert_no_session
+  end
+
   test "reader token Collection links end with trailing slash" do
     # Testing the fix for #2937.
-    show_collection(:foo_file, :active_trustedclient)
-    post(:share, collection_params(:foo_file))
+    session = session_for(:active_trustedclient)
+    post(:share, collection_params(:foo_file), session)
     assert(@controller.download_link.ends_with? '/',
            "Collection share link does not end with slash for wget")
   end
@@ -111,9 +117,10 @@ class CollectionsControllerTest < ActionController::TestCase
   test "getting a file from Keep" do
     params = collection_params(:foo_file, 'foo')
     sess = session_for(:active)
+    expect_content = stub_file_content
     get(:show_file, params, sess)
     assert_response :success
-    assert_equal(expected_contents(params, sess), @response.body,
+    assert_equal(expect_content, @response.body,
                  "failed to get a correct file from Keep")
   end
 
@@ -135,9 +142,10 @@ class CollectionsControllerTest < ActionController::TestCase
     params = collection_params(:foo_file, 'foo')
     read_token = api_fixture('api_client_authorizations')['active']['api_token']
     params[:reader_token] = read_token
+    expect_content = stub_file_content
     get(:show_file, params)
     assert_response :success
-    assert_equal(expected_contents(params, read_token), @response.body,
+    assert_equal(expect_content, @response.body,
                  "failed to get a correct file from Keep using a reader token")
     assert_not_equal(read_token, session[:arvados_api_token],
                      "using a reader token set the session's API token")
@@ -156,9 +164,10 @@ class CollectionsControllerTest < ActionController::TestCase
     sess = session_for(:expired)
     read_token = api_fixture('api_client_authorizations')['active']['api_token']
     params[:reader_token] = read_token
+    expect_content = stub_file_content
     get(:show_file, params, sess)
     assert_response :success
-    assert_equal(expected_contents(params, read_token), @response.body,
+    assert_equal(expect_content, @response.body,
                  "failed to get a correct file from Keep using a reader token")
     assert_not_equal(read_token, session[:arvados_api_token],
                      "using a reader token set the session's API token")
@@ -166,6 +175,10 @@ class CollectionsControllerTest < ActionController::TestCase
 
   test "inactive user can retrieve user agreement" do
     ua_collection = api_fixture('collections')['user_agreement']
+    # Here we don't test whether the agreement can be retrieved from
+    # Keep. We only test that show_file decides to send file content,
+    # so we use the file content stub.
+    stub_file_content
     get :show_file, {
       uuid: ua_collection['uuid'],
       file: ua_collection['manifest_text'].match(/ \d+:\d+:(\S+)/)[1]
@@ -180,4 +193,37 @@ class CollectionsControllerTest < ActionController::TestCase
     show_collection({uuid: NONEXISTENT_COLLECTION, id: NONEXISTENT_COLLECTION},
                     :active, 404)
   end
+
+  test "use a reasonable read buffer even if client requests a huge range" do
+    fakefiledata = mock
+    IO.expects(:popen).returns(fakefiledata)
+    fakefiledata.expects(:read).twice.with() do |length|
+      # Fail the test if read() is called with length>1MiB:
+      length < 2**20
+      ## Force the ActionController::Live thread to lose the race to
+      ## verify that @response.body.length actually waits for the
+      ## response (see below):
+      # sleep 3
+    end.returns("foo\n", nil)
+    fakefiledata.expects(:close)
+    foo_file = api_fixture('collections')['foo_file']
+    @request.headers['Range'] = 'bytes=0-4294967296/*'
+    get :show_file, {
+      uuid: foo_file['uuid'],
+      file: foo_file['manifest_text'].match(/ \d+:\d+:(\S+)/)[1]
+    }, session_for(:active)
+    # Wait for the whole response to arrive before deciding whether
+    # mocks' expectations were met. Otherwise, Mocha will fail the
+    # test depending on how slowly the ActionController::Live thread
+    # runs.
+    @response.body.length
+  end
+
+  test "show file in a subdirectory of a collection" do
+    params = collection_params(:collection_with_files_in_subdir, 'subdir2/subdir3/subdir4/file1_in_subdir4.txt')
+    expect_content = stub_file_content
+    get(:show_file, params, session_for(:user1_with_load))
+    assert_response :success
+    assert_equal(expect_content, @response.body, "failed to get a correct file from Keep")
+  end
 end