AwsS3SetUpTearDownTrait::tearDown() - Code Metrics - Inspection of "Add support for aws-sdk-php v2" - Gaufrette/extras - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Albin

created 2017-06-02 12:10 UTC

AwsS3SetUpTearDownTrait::tearDown() A

↳ Parent: AwsS3SetUpTearDownTrait

Complexity

Conditions	4
Paths	3

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
rs	9.2
cc	4
eloc	8
nc	3
nop	0

<?php

namespace Gaufrette\Extras\Tests\Resolvable\Resolver;

use Aws\S3\S3Client;

/**
 * @TODO: To be removed
 * @see https://github.com/KnpLabs/Gaufrette/pull/494
 */
trait AwsS3SetUpTearDownTrait
{
    /** @var string */
    private $bucket;

    /** @var S3Client */
    private $client;

    public function setUp()
    {
        $key    = getenv('AWS_KEY');
        $secret = getenv('AWS_SECRET');
        $region = getenv('AWS_REGION');

        if (empty($key) || empty($secret)) {
            $this->markTestSkipped('Missing AWS_KEY and/or AWS_SECRET env vars.');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        $this->bucket = uniqid(getenv('AWS_BUCKET'));

        // For AWS SDK v2
        if (class_exists('Aws\Common\Client\AbstractClient')) {
            return $this->client = S3Client::factory([

                'region' => $region ? $region : 'eu-west-1',
                'version' => '2006-03-01',
                'key' => $key,
                'secret' => $secret,
            ]);
        }

        // For AWS SDK v3
        $this->client = new S3Client([
            'region'      => $region ? $region : 'eu-west-1',
            'version'     => 'latest',
            'credentials' => [
                'key'    => $key,
                'secret' => $secret,
            ],
        ]);
    }

    public function tearDown()
    {
        if ($this->client === null || !$this->client->doesBucketExist($this->bucket)) {
            return;
        }

        $result = $this->client->listObjects(['Bucket' => $this->bucket]);
        $staleObjects = $result->get('Contents');

        foreach ($staleObjects as $staleObject) {
            $this->client->deleteObject(['Bucket' => $this->bucket, 'Key' => $staleObject['Key']]);
        }

        $this->client->deleteBucket(['Bucket' => $this->bucket]);
    }
}


1			<?php
2
3			namespace Gaufrette\Extras\Tests\Resolvable\Resolver;
4
5			use Aws\S3\S3Client;
6
7			/**
8			* @TODO: To be removed
9			* @see https://github.com/KnpLabs/Gaufrette/pull/494
10			*/
11			trait AwsS3SetUpTearDownTrait
12			{
13			/** @var string */
14			private $bucket;
15
16			/** @var S3Client */
17			private $client;
18
19			public function setUp()
20			{
21			$key = getenv('AWS_KEY');
22			$secret = getenv('AWS_SECRET');
23			$region = getenv('AWS_REGION');
24
25			if (empty($key) \|\| empty($secret)) {
26			$this->markTestSkipped('Missing AWS_KEY and/or AWS_SECRET env vars.');
			0 ignored issues – show Bug introduced 2017-05-29 22:57 UTC by Report Bug Copy Issue Report It seems like `markTestSkipped()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
27			}
28
29			$this->bucket = uniqid(getenv('AWS_BUCKET'));
30
31			// For AWS SDK v2
32			if (class_exists('Aws\Common\Client\AbstractClient')) {
33			return $this->client = S3Client::factory([
			0 ignored issues – show Deprecated Code introduced 2017-06-02 12:11 UTC by Report Bug Copy Issue Report The method `Aws\AwsClient::factory()` has been deprecated. This method has been deprecated. Loading history...
34			'region' => $region ? $region : 'eu-west-1',
35			'version' => '2006-03-01',
36			'key' => $key,
37			'secret' => $secret,
38			]);
39			}
40
41			// For AWS SDK v3
42			$this->client = new S3Client([
43			'region' => $region ? $region : 'eu-west-1',
44			'version' => 'latest',
45			'credentials' => [
46			'key' => $key,
47			'secret' => $secret,
48			],
49			]);
50			}
51
52			public function tearDown()
53			{
54			if ($this->client === null \|\| !$this->client->doesBucketExist($this->bucket)) {
55			return;
56			}
57
58			$result = $this->client->listObjects(['Bucket' => $this->bucket]);
59			$staleObjects = $result->get('Contents');
60
61			foreach ($staleObjects as $staleObject) {
62			$this->client->deleteObject(['Bucket' => $this->bucket, 'Key' => $staleObject['Key']]);
63			}
64
65			$this->client->deleteBucket(['Bucket' => $this->bucket]);
66			}
67			}
68

Gaufrette / extras

Pull Request — master (#3)

AwsS3SetUpTearDownTrait::tearDown() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like