S3ClientStub::throwDuringUpload() - Code Metrics - Inspection of "Test failing to write a file on AWS" - thephpleague/flysystem-aws-s3-v3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.x ( c89931...bb002c )

by Frank

created 2021-04-10 21:14 UTC

S3ClientStub::throwDuringUpload() A

↳ Parent: S3ClientStub

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

namespace League\Flysystem\AwsS3V3;

use Aws\Command;
use Aws\CommandInterface;
use Aws\ResultInterface;
use Aws\S3\Exception\S3Exception;
use Aws\S3\S3ClientInterface;
use Aws\S3\S3ClientTrait;
use GuzzleHttp\Psr7\Response;

use Throwable;

use function GuzzleHttp\Promise\promise_for;

/**
 * @codeCoverageIgnore
 */
class S3ClientStub implements S3ClientInterface
{
    use S3ClientTrait;

    /**
     * @var S3ClientInterface
     */
    private $actualClient;

    /**
     * @var S3Exception[]
     */
    private $stagedExceptions = [];

    /**
     * @var ResultInterface[]
     */
    private $stagedResult = [];

    /**
     * @var Throwable|null
     */
    private $exceptionForUpload = null;

    public function __construct(S3ClientInterface $client)
    {
        return $this->actualClient = $client;

    }

    public function throwDuringUpload(Throwable $throwable): void
    {
        $this->exceptionForUpload = $throwable;
    }

    public function upload($bucket, $key, $body, $acl = 'private', array $options = [])
    {
        if ($this->exceptionForUpload instanceof Throwable) {
            $throwable = $this->exceptionForUpload;
            $this->exceptionForUpload = null;
            throw $throwable;
        }
    }

    public function failOnNextCopy(): void
    {
        $this->throwExceptionWhenExecutingCommand('CopyObject');
    }

    public function throwExceptionWhenExecutingCommand(string $commandName, S3Exception $exception = null): void
    {
        $this->stagedExceptions[$commandName] = $exception ?: new S3Exception($commandName, new Command($commandName));
    }

    public function throw500ExceptionWhenExecutingCommand(string $commandName): void
    {
        $response = new Response(500);
        $exception = new S3Exception($commandName, new Command($commandName), compact('response'));

        $this->throwExceptionWhenExecutingCommand($commandName, $exception);
    }

    public function stageResultForCommand(string $commandName, ResultInterface $result): void
    {
        $this->stagedResult[$commandName] = $result;
    }

    public function execute(CommandInterface $command)
    {
        return $this->executeAsync($command)->wait();
    }

    public function getCommand($name, array $args = [])
    {
        return $this->actualClient->getCommand($name, $args);
    }

    public function getHandlerList()
    {
        return $this->actualClient->getHandlerList();
    }

    public function getIterator($name, array $args = [])
    {
        return $this->actualClient->getIterator($name, $args);
    }

    public function __call($name, array $arguments)
    {
        return $this->actualClient->__call($name, $arguments);
    }

    public function executeAsync(CommandInterface $command)
    {
        $name = $command->getName();

        if (array_key_exists($name, $this->stagedExceptions)) {
            $exception = $this->stagedExceptions[$name];
            unset($this->stagedExceptions[$name]);
            throw $exception;
        }

        if (array_key_exists($name, $this->stagedResult)) {
            $result = $this->stagedResult[$name];
            unset($this->stagedResult[$name]);

            return promise_for($result);

        }

        return $this->actualClient->executeAsync($command);
    }

    public function getCredentials()
    {
        return $this->actualClient->getCredentials();
    }

    public function getRegion()
    {
        return $this->actualClient->getRegion();
    }

    public function getEndpoint()
    {
        return $this->actualClient->getEndpoint();
    }

    public function getApi()
    {
        return $this->actualClient->getApi();
    }

    public function getConfig($option = null)
    {
        return $this->actualClient->getConfig($option);
    }

    public function getPaginator($name, array $args = [])
    {
        return $this->actualClient->getPaginator($name, $args);
    }

    public function waitUntil($name, array $args = [])
    {
        $this->actualClient->waitUntil($name, $args);
    }

    public function getWaiter($name, array $args = [])
    {
        return $this->actualClient->getWaiter($name, $args);
    }

    public function createPresignedRequest(CommandInterface $command, $expires, array $options = [])
    {
        return $this->actualClient->createPresignedRequest($command, $expires, $options);
    }

    public function getObjectUrl($bucket, $key)
    {
        return $this->actualClient->getObjectUrl($bucket, $key);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace League\Flysystem\AwsS3V3;
6
7			use Aws\Command;
8			use Aws\CommandInterface;
9			use Aws\ResultInterface;
10			use Aws\S3\Exception\S3Exception;
11			use Aws\S3\S3ClientInterface;
12			use Aws\S3\S3ClientTrait;
13			use GuzzleHttp\Psr7\Response;
14
15			use Throwable;
16
17			use function GuzzleHttp\Promise\promise_for;
18
19			/**
20			* @codeCoverageIgnore
21			*/
22			class S3ClientStub implements S3ClientInterface
23			{
24			use S3ClientTrait;
25
26			/**
27			* @var S3ClientInterface
28			*/
29			private $actualClient;
30
31			/**
32			* @var S3Exception[]
33			*/
34			private $stagedExceptions = [];
35
36			/**
37			* @var ResultInterface[]
38			*/
39			private $stagedResult = [];
40
41			/**
42			* @var Throwable\|null
43			*/
44			private $exceptionForUpload = null;
45
46			public function __construct(S3ClientInterface $client)
47			{
48			return $this->actualClient = $client;
			0 ignored issues – show Bug introduced 2020-10-13 12:48 UTC by Report Bug Copy Issue Report Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct? Loading history...
49			}
50
51			public function throwDuringUpload(Throwable $throwable): void
52			{
53			$this->exceptionForUpload = $throwable;
54			}
55
56			public function upload($bucket, $key, $body, $acl = 'private', array $options = [])
57			{
58			if ($this->exceptionForUpload instanceof Throwable) {
59			$throwable = $this->exceptionForUpload;
60			$this->exceptionForUpload = null;
61			throw $throwable;
62			}
63			}
64
65			public function failOnNextCopy(): void
66			{
67			$this->throwExceptionWhenExecutingCommand('CopyObject');
68			}
69
70			public function throwExceptionWhenExecutingCommand(string $commandName, S3Exception $exception = null): void
71			{
72			$this->stagedExceptions[$commandName] = $exception ?: new S3Exception($commandName, new Command($commandName));
73			}
74
75			public function throw500ExceptionWhenExecutingCommand(string $commandName): void
76			{
77			$response = new Response(500);
78			$exception = new S3Exception($commandName, new Command($commandName), compact('response'));
79
80			$this->throwExceptionWhenExecutingCommand($commandName, $exception);
81			}
82
83			public function stageResultForCommand(string $commandName, ResultInterface $result): void
84			{
85			$this->stagedResult[$commandName] = $result;
86			}
87
88			public function execute(CommandInterface $command)
89			{
90			return $this->executeAsync($command)->wait();
91			}
92
93			public function getCommand($name, array $args = [])
94			{
95			return $this->actualClient->getCommand($name, $args);
96			}
97
98			public function getHandlerList()
99			{
100			return $this->actualClient->getHandlerList();
101			}
102
103			public function getIterator($name, array $args = [])
104			{
105			return $this->actualClient->getIterator($name, $args);
106			}
107
108			public function __call($name, array $arguments)
109			{
110			return $this->actualClient->__call($name, $arguments);
111			}
112
113			public function executeAsync(CommandInterface $command)
114			{
115			$name = $command->getName();
116
117			if (array_key_exists($name, $this->stagedExceptions)) {
118			$exception = $this->stagedExceptions[$name];
119			unset($this->stagedExceptions[$name]);
120			throw $exception;
121			}
122
123			if (array_key_exists($name, $this->stagedResult)) {
124			$result = $this->stagedResult[$name];
125			unset($this->stagedResult[$name]);
126
127			return promise_for($result);
			0 ignored issues – show Deprecated Code introduced 2020-10-21 19:36 UTC by Report Bug Copy Issue Report The function `GuzzleHttp\Promise\promise_for()` has been deprecated with message: promise_for will be removed in guzzlehttp/promises:2.0. Use Create::promiseFor instead. This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
128			}
129
130			return $this->actualClient->executeAsync($command);
131			}
132
133			public function getCredentials()
134			{
135			return $this->actualClient->getCredentials();
136			}
137
138			public function getRegion()
139			{
140			return $this->actualClient->getRegion();
141			}
142
143			public function getEndpoint()
144			{
145			return $this->actualClient->getEndpoint();
146			}
147
148			public function getApi()
149			{
150			return $this->actualClient->getApi();
151			}
152
153			public function getConfig($option = null)
154			{
155			return $this->actualClient->getConfig($option);
156			}
157
158			public function getPaginator($name, array $args = [])
159			{
160			return $this->actualClient->getPaginator($name, $args);
161			}
162
163			public function waitUntil($name, array $args = [])
164			{
165			$this->actualClient->waitUntil($name, $args);
166			}
167
168			public function getWaiter($name, array $args = [])
169			{
170			return $this->actualClient->getWaiter($name, $args);
171			}
172
173			public function createPresignedRequest(CommandInterface $command, $expires, array $options = [])
174			{
175			return $this->actualClient->createPresignedRequest($command, $expires, $options);
176			}
177
178			public function getObjectUrl($bucket, $key)
179			{
180			return $this->actualClient->getObjectUrl($bucket, $key);
181			}
182			}
183

thephpleague / flysystem-aws-s3-v3

Push — 2.x ( c89931...bb002c )

S3ClientStub::throwDuringUpload() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like