Updates to AWS Snapshot copy E2E test (#503)

* Updates to AWS Snapshot copy E2E test

* Linter appeasement

Author: ramo-j

libcloudforensics/providers/aws/forensics.py

@@ -440,7 +440,8 @@ def CopyEBSSnapshotToS3Process(
   curr_wait = 0
   success = False
   prefix = '{0:s}/{1:s}/'.format(object_path, snapshot_id)
-  files = ['image.bin', 'log.txt', 'hlog.txt', 'mlog.txt']
+  files = ['image.bin', 'log.txt', 'hlog.txt', 'mlog.txt',
+           'instance_copy_stdout.txt', 'instance_copy_stderr.txt']
 
   logger.info('Transfer expected to take {0:d} seconds'.
     format(snapshot_size * transfer_speed))

libcloudforensics/scripts/ebs_snapshot_copy_aws.sh

@@ -12,11 +12,22 @@ function ebsCopy {{
 	snapshot=$1
 	bucket=$2
 
+	echo snapshot: "$snapshot"
+	echo bucket: "$bucket"
+
+	# Install utilities
+	amazon-linux-extras install epel -y
+	yum install jq dc3dd -y
+
 	# Get details about self
 	region=$(curl -s http://169.254.169.254/latest/meta-data/placement/region)
 	az=$(curl -s http://169.254.169.254/latest/meta-data/placement/availability-zone)
 	instance=$(curl -s http://169.254.169.254/latest/meta-data/instance-id)
 
+	echo region: "$region"
+	echo az: "$az"
+	echo instance: "$instance"
+
 	# create the new volume
 	volume=$(aws ec2 --region $region create-volume --availability-zone $az --snapshot-id $snapshot --tag-specification 'ResourceType=volume,Tags=[{{Key=Name,Value=volumeToCopy}}]' | jq -r .VolumeId)
 
@@ -44,9 +55,11 @@ function ebsCopy {{
 	aws ec2 --region $region delete-volume --volume-id $volume
 }}
 
-amazon-linux-extras install epel -y
-yum install jq dc3dd -y
+ebsCopy $snapshot $bucket 2> /tmp/err > /tmp/out
+
+aws s3 cp /tmp/out $bucket/$snapshot/instance_copy_stdout.txt
+aws s3 cp /tmp/err $bucket/$snapshot/instance_copy_stderr.txt
 
-ebsCopy $snapshot $bucket
+sleep 5
 
 poweroff

tests/providers/aws/e2e.py

@@ -286,21 +286,33 @@ class CopyEBSSnapshotToS3E2ETest(unittest.TestCase):
   guidelines in https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html # pylint: disable=line-too-long
   """
 
-  @classmethod
+  expected_filenames = ['image.bin', 'log.txt', 'hlog.txt', 'mlog.txt',
+                        'instance_copy_stdout.txt', 'instance_copy_stderr.txt']
+
   @typing.no_type_check
   @IgnoreWarnings
-  def setUpClass(cls):
+  def setUp(self):
     try:
       project_info = utils.ReadProjectInfo(
           ['s3_destination', 'zone', 'snapshot_id'])
     except (OSError, RuntimeError, ValueError) as exception:
       raise unittest.SkipTest(str(exception))
-    cls.zone = project_info['zone']
-    cls.aws = account.AWSAccount(cls.zone)
-    cls.subnet_id = project_info.get('subnet_id', None)
-    cls.security_group_id = project_info.get('security_group_id', None)
-    cls.s3_destination = project_info.get('s3_destination', None)
-    cls.snapshot_id = project_info.get('snapshot_id', None)
+    self.zone = project_info['zone']
+    self.aws_account: account.AWSAccount = account.AWSAccount(self.zone)
+    self.subnet_id = project_info.get('subnet_id', None)
+    self.security_group_id = project_info.get('security_group_id', None)
+    self.s3_destination = project_info.get('s3_destination', None)
+    self.snapshot_id = project_info.get('snapshot_id', None)
+
+    if not self.s3_destination.startswith('s3://'):
+      self.s3_destination = 's3://' + self.s3_destination
+    path_components = SplitStoragePath(self.s3_destination)
+    self.bucket: str = path_components[0]
+    self.object_path: str = path_components[1]
+    self.directory: str = '{0:s}/{1:s}/'.format(
+        self.object_path, self.snapshot_id)
+
+    super().setUp()
 
   @typing.no_type_check
   @IgnoreWarnings
@@ -309,13 +321,6 @@ def testCopyEBSSnapshotToS3(self):
 
     Test copying an EBS snapshot into S3.
     """
-
-    if not self.s3_destination.startswith('s3://'):
-      self.s3_destination = 's3://' + self.s3_destination
-    path_components = SplitStoragePath(self.s3_destination)
-    bucket = path_components[0]
-    object_path = path_components[1]
-
     forensics.CopyEBSSnapshotToS3(
       self.s3_destination,
       self.snapshot_id,
@@ -325,22 +330,19 @@ def testCopyEBSSnapshotToS3(self):
       security_group_id=self.security_group_id,
       cleanup_iam=True)
 
-    aws_account = account.AWSAccount(self.zone)
-    directory = '{0:s}/{1:s}/'.format(object_path, self.snapshot_id)
-    self.assertEqual(
-      aws_account.s3.CheckForObject(bucket, directory + 'image.bin'), True)
-    self.assertEqual(
-      aws_account.s3.CheckForObject(bucket, directory + 'log.txt'), True)
-    self.assertEqual(
-      aws_account.s3.CheckForObject(bucket, directory + 'hlog.txt'), True)
-    self.assertEqual(
-      aws_account.s3.CheckForObject(bucket, directory + 'mlog.txt'), True)
-
-    # Cleanup
-    aws_account.s3.RmObject(bucket, directory + 'image.bin')
-    aws_account.s3.RmObject(bucket, directory + 'log.txt')
-    aws_account.s3.RmObject(bucket, directory + 'hlog.txt')
-    aws_account.s3.RmObject(bucket, directory + 'mlog.txt')
+    for file in self.expected_filenames:
+      self.assertTrue(self.aws_account.s3.CheckForObject(
+          self.bucket, self.directory + file))
+
+  def tearDown(self) -> None:
+    """Remove the created resources."""
+    for file in self.expected_filenames:
+      try:
+        self.aws_account.s3.RmObject(
+            self.bucket, self.directory + file)
+      except Exception as error:  # pylint: disable=broad-exception-caught
+        logger.exception(
+            'Error cleaning up %s: {%s}', file, str(error), exc_info=True)
 
 
 class S3EndToEndTest(unittest.TestCase):