| # -*- coding: utf-8 -*- |
| # Copyright 2013 Google Inc. All Rights Reserved. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| """Tests for compose command.""" |
| |
| from __future__ import absolute_import |
| |
| from gslib.commands.compose import MAX_COMPOSE_ARITY |
| from gslib.cs_api_map import ApiSelector |
| import gslib.tests.testcase as testcase |
| from gslib.tests.testcase.integration_testcase import SkipForS3 |
| from gslib.tests.util import ObjectToURI as suri |
| |
| |
| @SkipForS3('S3 does not support object composition.') |
| class TestCompose(testcase.GsUtilIntegrationTestCase): |
| """Integration tests for compose command.""" |
| |
| def check_n_ary_compose(self, num_components): |
| """Tests composing num_components object.""" |
| bucket_uri = self.CreateBucket() |
| |
| data_list = ['data-%d,' % i for i in xrange(num_components)] |
| components = [self.CreateObject(bucket_uri=bucket_uri, contents=data).uri |
| for data in data_list] |
| |
| composite = bucket_uri.clone_replace_name(self.MakeTempName('obj')) |
| |
| self.RunGsUtil(['compose'] + components + [composite.uri]) |
| self.assertEqual(composite.get_contents_as_string(), ''.join(data_list)) |
| |
| def test_compose_too_many_fails(self): |
| components = ['gs://b/component-obj'] * (MAX_COMPOSE_ARITY + 1) |
| stderr = self.RunGsUtil(['compose'] + components + ['gs://b/composite-obj'], |
| expected_status=1, return_stderr=True) |
| self.assertIn('command accepts at most', stderr) |
| |
| def test_compose_too_few_fails(self): |
| stderr = self.RunGsUtil( |
| ['compose', 'gs://b/component-obj', 'gs://b/composite-obj'], |
| expected_status=1, return_stderr=True) |
| self.assertIn( |
| 'CommandException: "compose" requires at least 2 component objects.\n', |
| stderr) |
| |
| def test_compose_between_buckets_fails(self): |
| target = 'gs://b/composite-obj' |
| offending_obj = 'gs://alt-b/obj2' |
| components = ['gs://b/obj1', offending_obj] |
| stderr = self.RunGsUtil(['compose'] + components + [target], |
| expected_status=1, return_stderr=True) |
| expected_msg = ( |
| 'CommandException: GCS does ' |
| 'not support inter-bucket composing.\n') |
| self.assertIn(expected_msg, stderr) |
| |
| def test_versioned_target_disallowed(self): |
| stderr = self.RunGsUtil( |
| ['compose', 'gs://b/o1', 'gs://b/o2', 'gs://b/o3#1234'], |
| expected_status=1, return_stderr=True) |
| expected_msg = ('CommandException: A version-specific URL (%s) ' |
| 'cannot be the destination for gsutil compose - abort.' |
| % 'gs://b/o3#1234') |
| self.assertIn(expected_msg, stderr) |
| |
| def test_simple_compose(self): |
| self.check_n_ary_compose(2) |
| |
| def test_maximal_compose(self): |
| self.check_n_ary_compose(MAX_COMPOSE_ARITY) |
| |
| def test_compose_with_wildcard(self): |
| """Tests composing objects with a wildcarded URI.""" |
| bucket_uri = self.CreateBucket() |
| |
| component1 = self.CreateObject( |
| bucket_uri=bucket_uri, contents='hello ', object_name='component1') |
| component2 = self.CreateObject( |
| bucket_uri=bucket_uri, contents='world!', object_name='component2') |
| |
| composite = bucket_uri.clone_replace_name(self.MakeTempName('obj')) |
| |
| self.RunGsUtil(['compose', component1.uri, component2.uri, composite.uri]) |
| self.assertEqual(composite.get_contents_as_string(), 'hello world!') |
| |
| def test_compose_with_precondition(self): |
| """Tests composing objects with a destination precondition.""" |
| # Tests that cp -v option handles the if-generation-match header correctly. |
| bucket_uri = self.CreateVersionedBucket() |
| k1_uri = self.CreateObject(bucket_uri=bucket_uri, contents='data1') |
| k2_uri = self.CreateObject(bucket_uri=bucket_uri, contents='data2') |
| g1 = k1_uri.generation |
| |
| gen_match_header = 'x-goog-if-generation-match:%s' % g1 |
| # Append object 1 and 2 |
| self.RunGsUtil(['-h', gen_match_header, 'compose', suri(k1_uri), |
| suri(k2_uri), suri(k1_uri)]) |
| |
| # Second compose should fail the precondition. |
| stderr = self.RunGsUtil(['-h', gen_match_header, 'compose', suri(k1_uri), |
| suri(k2_uri), suri(k1_uri)], |
| return_stderr=True, expected_status=1) |
| |
| self.assertIn('PreconditionException', stderr) |
| |
| def test_compose_missing_second_source_object(self): |
| bucket_uri = self.CreateBucket() |
| object_uri = self.CreateObject(bucket_uri=bucket_uri, contents='foo') |
| |
| # Compose with missing source object |
| stderr = self.RunGsUtil(['compose', suri(object_uri), |
| suri(bucket_uri, 'nonexistent-obj'), |
| suri(bucket_uri, 'valid-destination')], |
| expected_status=1, return_stderr=True) |
| self.assertIn('NotFoundException', stderr) |
| if self.test_api == ApiSelector.JSON: |
| self.assertIn('One of the source objects does not exist', stderr) |
| |
| |
| class TestCompatibleCompose(testcase.GsUtilIntegrationTestCase): |
| |
| def test_compose_non_gcs_target(self): |
| stderr = self.RunGsUtil(['compose', 'gs://b/o1', 'gs://b/o2', 's3://b/o3'], |
| expected_status=1, return_stderr=True) |
| expected_msg = ('CommandException: "compose" called on URL with ' |
| 'unsupported provider (%s).\n' % 's3://b/o3') |
| self.assertIn(expected_msg, stderr) |
| |
| def test_compose_non_gcs_component(self): |
| stderr = self.RunGsUtil(['compose', 'gs://b/o1', 's3://b/o2', 'gs://b/o3'], |
| expected_status=1, return_stderr=True) |
| expected_msg = ('CommandException: "compose" called on URL with ' |
| 'unsupported provider (%s).\n' % 's3://b/o2') |
| self.assertIn(expected_msg, stderr) |
| |
