# -*- 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.
"""Integration tests for lifecycle command."""
from __future__ import absolute_import
import json
import posixpath
from xml.dom.minidom import parseString
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
from gslib.tests.util import unittest
from gslib.translation_helper import LifecycleTranslation
from gslib.util import Retry
@SkipForS3('Lifecycle command is only supported for gs:// URLs')
class TestSetLifecycle(testcase.GsUtilIntegrationTestCase):
"""Integration tests for lifecycle command."""
empty_doc1 = '{}'
xml_doc = parseString(
'<LifecycleConfiguration><Rule>'
'<Action><Delete/></Action>'
'<Condition><Age>365</Age></Condition>'
'</Rule></LifecycleConfiguration>').toprettyxml(indent=' ')
bad_doc = (
'{"rule": [{"action": {"type": "Add"}, "condition": {"age": 365}}]}\n')
lifecycle_doc = (
'{"rule": [{"action": {"type": "Delete"}, "condition": {"age": 365}}]}\n')
lifecycle_json_obj = json.loads(lifecycle_doc)
lifecycle_doc_bucket_style = (
'{"lifecycle": {"rule": [{"action": {"type": "Delete"}, "condition": '
'{"age": 365}}]}}\n')
lifecycle_created_before_doc = (
'{"rule": [{"action": {"type": "Delete"}, "condition": '
'{"createdBefore": "2014-10-01"}}]}\n')
lifecycle_created_before_json_obj = json.loads(lifecycle_created_before_doc)
no_lifecycle_config = 'has no lifecycle configuration.'
def test_lifecycle_translation(self):
"""Tests lifecycle translation for various formats."""
json_text = self.lifecycle_doc
entries_list = LifecycleTranslation.JsonLifecycleToMessage(json_text)
boto_lifecycle = LifecycleTranslation.BotoLifecycleFromMessage(entries_list)
converted_entries_list = LifecycleTranslation.BotoLifecycleToMessage(
boto_lifecycle)
converted_json_text = LifecycleTranslation.JsonLifecycleFromMessage(
converted_entries_list)
self.assertEqual(json.loads(json_text), json.loads(converted_json_text))
def test_default_lifecycle(self):
bucket_uri = self.CreateBucket()
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertIn(self.no_lifecycle_config, stdout)
def test_set_empty_lifecycle1(self):
bucket_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.empty_doc1)
self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertIn(self.no_lifecycle_config, stdout)
def test_valid_lifecycle(self):
bucket_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.lifecycle_doc)
self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)
def test_valid_lifecycle_bucket_style(self):
bucket_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.lifecycle_doc_bucket_style)
self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)
def test_created_before_lifecycle(self):
bucket_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.lifecycle_created_before_doc)
self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_created_before_json_obj)
def test_bad_lifecycle(self):
bucket_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.bad_doc)
stderr = self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)],
expected_status=1, return_stderr=True)
self.assertNotIn('XML lifecycle data provided', stderr)
def test_bad_xml_lifecycle(self):
bucket_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.xml_doc)
stderr = self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)],
expected_status=1, return_stderr=True)
self.assertIn('XML lifecycle data provided', stderr)
def test_set_lifecycle_and_reset(self):
"""Tests setting and turning off lifecycle configuration."""
bucket_uri = self.CreateBucket()
tmpdir = self.CreateTempDir()
fpath = self.CreateTempFile(tmpdir=tmpdir, contents=self.lifecycle_doc)
self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)
fpath = self.CreateTempFile(tmpdir=tmpdir, contents=self.empty_doc1)
self.RunGsUtil(['lifecycle', 'set', fpath, suri(bucket_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket_uri)],
return_stdout=True)
self.assertIn(self.no_lifecycle_config, stdout)
def test_set_lifecycle_multi_buckets(self):
"""Tests setting lifecycle configuration on multiple buckets."""
bucket1_uri = self.CreateBucket()
bucket2_uri = self.CreateBucket()
fpath = self.CreateTempFile(contents=self.lifecycle_doc)
self.RunGsUtil(
['lifecycle', 'set', fpath, suri(bucket1_uri), suri(bucket2_uri)])
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket1_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket2_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)
def test_set_lifecycle_wildcard(self):
"""Tests setting lifecycle with a wildcarded bucket URI."""
if self.test_api == ApiSelector.XML:
# This test lists buckets with wildcards, but it is possible that another
# test being run in parallel (in the same project) deletes a bucket after
# it is listed in this test. This causes the subsequent XML metadata get
# for the lifecycle configuration to fail on that just-deleted bucket,
# even though that bucket is not used directly in this test.
return unittest.skip('XML wildcard behavior can cause test to flake '
'if a bucket in the same project is deleted '
'during execution.')
random_prefix = self.MakeRandomTestString()
bucket1_name = self.MakeTempName('bucket', prefix=random_prefix)
bucket2_name = self.MakeTempName('bucket', prefix=random_prefix)
bucket1_uri = self.CreateBucket(bucket_name=bucket1_name)
bucket2_uri = self.CreateBucket(bucket_name=bucket2_name)
# This just double checks that the common prefix of the two buckets is what
# we think it should be (based on implementation detail of CreateBucket).
# We want to be careful when setting a wildcard on buckets to make sure we
# don't step outside the test buckets to affect other buckets.
common_prefix = posixpath.commonprefix([suri(bucket1_uri),
suri(bucket2_uri)])
self.assertTrue(common_prefix.startswith(
'gs://%sgsutil-test-test_set_lifecycle_wildcard-' % random_prefix))
wildcard = '%s*' % common_prefix
fpath = self.CreateTempFile(contents=self.lifecycle_doc)
# Use @Retry as hedge against bucket listing eventual consistency.
expected = set([
'Setting lifecycle configuration on %s/...' % suri(bucket1_uri),
'Setting lifecycle configuration on %s/...' % suri(bucket2_uri)])
actual = set()
@Retry(AssertionError, tries=3, timeout_secs=1)
def _Check1():
stderr = self.RunGsUtil(['lifecycle', 'set', fpath, wildcard],
return_stderr=True)
actual.update(stderr.splitlines())
self.assertEqual(expected, actual)
self.assertEqual(stderr.count('Setting lifecycle configuration'), 2)
_Check1()
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket1_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)
stdout = self.RunGsUtil(['lifecycle', 'get', suri(bucket2_uri)],
return_stdout=True)
self.assertEqual(json.loads(stdout), self.lifecycle_json_obj)