OpenWeatherMapTest::testGetWeatherHistory() - Code Metrics - Inspection of "Updated the UVIndex implementation" - cmfcmf/OpenWeatherMap-PHP-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#132)

unknown

created 2019-05-07 07:21 UTC

OpenWeatherMapTest::testGetWeatherHistory() A

↳ Parent: OpenWeatherMapTest

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	0

<?php
/**
 * Copyright Zikula Foundation 2014 - Zikula Application Framework
 *
 * This work is contributed to the Zikula Foundation under one or more
 * Contributor Agreements and licensed to You under the following license:
 *
 * @license GNU/LGPv3 (or at your option any later version).
 * @package OpenWeatherMap-PHP-Api
 *
 * Please see the NOTICE file distributed with this source code for further
 * information regarding copyright and licensing.
 */

namespace Cmfcmf\OpenWeatherMap\Tests\OpenWeatherMap;

use \Cmfcmf\OpenWeatherMap;
use Cmfcmf\OpenWeatherMap\Exception;
use Cmfcmf\OpenWeatherMap\Tests\TestFetcher;

class OpenWeatherMapTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var string
     */
    protected $apiKey;

    /**
     * @var OpenWeatherMap
     */
    protected $owm;

    /**
     * @var OpenWeatherMap
     */
    protected $openWeather;

    /**
     * @var ExampleCacheTest
     */
    protected $cache;

    protected function setUp()
    {
        $ini = parse_ini_file(__DIR__.'/../Examples/ApiKey.ini');
        $myApiKey = $ini['api_key'];
        $this->apiKey = $myApiKey;
        $this->owm = new OpenWeatherMap($this->apiKey, new TestFetcher(), false, 600);
        $this->openWeather = new OpenWeatherMap($this->apiKey, null, false, 600);
        $this->cache = new ExampleCacheTest();
    }

    protected function tearDown()
    {
        $fileList = glob(__DIR__.'/temps/OpenWeatherMapPHPAPI/*');
        foreach ($fileList as $fileName) {
            @unlink($fileName);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }

        @rmdir(__DIR__.'/temps/OpenWeatherMapPHPAPI');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        @rmdir(__DIR__.'/temps');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
    }

    public function testApiKeyIsEmpty()
    {
        $expectApiKey = '';
        $weather = new OpenWeatherMap($expectApiKey, null, false, 600);
        $apiKey = $weather->getApiKey();

        $this->assertSame($expectApiKey, $apiKey);
    }

    public function testApiKeyNotNull()
    {
        $weather = $this->owm;
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    public function testSecondIsZero()
    {
        $weather = new OpenWeatherMap($this->apiKey, null, false, 0);
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    public function testSetApiKey()
    {
        $weather = $this->owm;
        $weather->setApiKey($this->apiKey);
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    public function testGetApiKey()
    {
        $weather = $this->owm;
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    public function testGetWeather()
    {
        $currentWeather = $this->owm->getWeather('Berlin', 'imperial', 'en', '');

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $currentWeather);
    }

    public function testGetWeatherGroup()
    {
        $currentWeather = $this->owm->getWeatherGroup(array('2950159'), 'imperial', 'en', '');
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);

        $currentWeather = $this->owm->getWeatherGroup('2950159', 'imperial', 'en', '');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);
    }

    public function testGetWeatherForecast()
    {
        $days = 1;
        $defaultDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);
        
        $days = 16;
        $maxDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $defaultDay);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $maxDay);
    }

    public function testGetCurrentUVIndex()
    {
        $owm = $this->openWeather;
        $result = $owm->getCurrentUVIndex(40.7, -74.2);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
    }

    public function testGetForecastUVIndex()
    {
        $owm = $this->openWeather;
        foreach ($precisions as $precision) {

            try {
                $result = $owm->getForecastUVIndex(40.7, -74.2, 5);
            } catch (Exception $e) {
                // OWM might not actually have data for the timespan.
                $this->assertSame('An error occurred: not found', $e->getMessage());
            }
            $this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
        }
    }

    public function testGetHistoryUVIndex()
    {
        $owm = $this->openWeather;
        foreach ($precisions as $precision) {

            try {
                $start = new \DateTime('1969-08-15');
                $end = new \DateTime('1969-08-18');
                $result = $owm->getForecastUVIndex(40.7, -74.2, null, $start, $end);

            } catch (Exception $e) {
                // OWM might not actually have data for the timespan.
                $this->assertSame('An error occurred: not found', $e->getMessage());
            }
            $this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }
    }

    public function testGetDailyWeatherForecast()
    {
        $days = 16;
        $dailyForecast = $this->owm->getDailyWeatherForecast('Berlin', 'imperial', 'en', '', $days);

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $dailyForecast);
    }

    public function testGetWeatherHistory()
    {
        $this->markTestSkipped('This getWeatherHistory method ignored because the api key need to have a paid permission.');
    }

    public function testWasCached()
    {
        $weather = $this->owm;
        $result = $weather->wasCached();

        $this->assertFalse($result);
    }

    public function testCached()
    {
        $cache = $this->cache;
        $cache->setTempPath(__DIR__.'/temps');
        $weather = new OpenWeatherMap($this->apiKey, new TestFetcher(), $cache, 600);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $currWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
        $cachedWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
        
        $this->assertInternalType('string', $currWeatherData);
        $this->assertInternalType('string', $cachedWeatherData);
    }

    public function testBuildQueryUrlParameter()
    {
        $weather = $this->owm;
        $queryWithNumbericArray = $weather->getWeather(array('2950159'), 'imperial', 'en', '');
        $queryWithLatLonArray = $weather->getWeather(array('lat' => 52.524368, 'lon' => 13.410530), 'imperial', 'en', '');

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithNumbericArray);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithLatLonArray);
    }

    public function testAbstractCache()
    {
        /** @var OpenWeatherMap\AbstractCache $sut */
        $sut = $this->getMockForAbstractClass('\Cmfcmf\OpenWeatherMap\AbstractCache');
        $this->assertNull($sut->setSeconds(10));
    }
}


1			<?php
2			/**
3			* Copyright Zikula Foundation 2014 - Zikula Application Framework
4			*
5			* This work is contributed to the Zikula Foundation under one or more
6			* Contributor Agreements and licensed to You under the following license:
7			*
8			* @license GNU/LGPv3 (or at your option any later version).
9			* @package OpenWeatherMap-PHP-Api
10			*
11			* Please see the NOTICE file distributed with this source code for further
12			* information regarding copyright and licensing.
13			*/
14
15			namespace Cmfcmf\OpenWeatherMap\Tests\OpenWeatherMap;
16
17			use \Cmfcmf\OpenWeatherMap;
18			use Cmfcmf\OpenWeatherMap\Exception;
19			use Cmfcmf\OpenWeatherMap\Tests\TestFetcher;
20
21			class OpenWeatherMapTest extends \PHPUnit_Framework_TestCase
22			{
23			/**
24			* @var string
25			*/
26			protected $apiKey;
27
28			/**
29			* @var OpenWeatherMap
30			*/
31			protected $owm;
32
33			/**
34			* @var OpenWeatherMap
35			*/
36			protected $openWeather;
37
38			/**
39			* @var ExampleCacheTest
40			*/
41			protected $cache;
42
43			protected function setUp()
44			{
45			$ini = parse_ini_file(__DIR__.'/../Examples/ApiKey.ini');
46			$myApiKey = $ini['api_key'];
47			$this->apiKey = $myApiKey;
48			$this->owm = new OpenWeatherMap($this->apiKey, new TestFetcher(), false, 600);
49			$this->openWeather = new OpenWeatherMap($this->apiKey, null, false, 600);
50			$this->cache = new ExampleCacheTest();
51			}
52
53			protected function tearDown()
54			{
55			$fileList = glob(__DIR__.'/temps/OpenWeatherMapPHPAPI/*');
56			foreach ($fileList as $fileName) {
57			@unlink($fileName);
			0 ignored issues – show Security Best Practice introduced 2016-12-30 20:39 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
58			}
59
60			@rmdir(__DIR__.'/temps/OpenWeatherMapPHPAPI');
			0 ignored issues – show Security Best Practice introduced 2016-12-30 20:39 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
61			@rmdir(__DIR__.'/temps');
			0 ignored issues – show Security Best Practice introduced 2016-12-30 20:39 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
62			}
63
64			public function testApiKeyIsEmpty()
65			{
66			$expectApiKey = '';
67			$weather = new OpenWeatherMap($expectApiKey, null, false, 600);
68			$apiKey = $weather->getApiKey();
69
70			$this->assertSame($expectApiKey, $apiKey);
71			}
72
73			public function testApiKeyNotNull()
74			{
75			$weather = $this->owm;
76			$apiKey = $weather->getApiKey();
77
78			$this->assertSame($this->apiKey, $apiKey);
79			}
80
81			public function testSecondIsZero()
82			{
83			$weather = new OpenWeatherMap($this->apiKey, null, false, 0);
84			$apiKey = $weather->getApiKey();
85
86			$this->assertSame($this->apiKey, $apiKey);
87			}
88
89			public function testSetApiKey()
90			{
91			$weather = $this->owm;
92			$weather->setApiKey($this->apiKey);
93			$apiKey = $weather->getApiKey();
94
95			$this->assertSame($this->apiKey, $apiKey);
96			}
97
98			public function testGetApiKey()
99			{
100			$weather = $this->owm;
101			$apiKey = $weather->getApiKey();
102
103			$this->assertSame($this->apiKey, $apiKey);
104			}
105
106			public function testGetWeather()
107			{
108			$currentWeather = $this->owm->getWeather('Berlin', 'imperial', 'en', '');
109
110			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $currentWeather);
111			}
112
113			public function testGetWeatherGroup()
114			{
115			$currentWeather = $this->owm->getWeatherGroup(array('2950159'), 'imperial', 'en', '');
116			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);
117
118			$currentWeather = $this->owm->getWeatherGroup('2950159', 'imperial', 'en', '');
			0 ignored issues – show Documentation introduced 2016-12-30 20:39 UTC by Report Bug Copy Issue Report `'2950159'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
119			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);
120			}
121
122			public function testGetWeatherForecast()
123			{
124			$days = 1;
125			$defaultDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);
126
127			$days = 16;
128			$maxDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);
129
130			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $defaultDay);
131			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $maxDay);
132			}
133
134			public function testGetCurrentUVIndex()
135			{
136			$owm = $this->openWeather;
137			$result = $owm->getCurrentUVIndex(40.7, -74.2);
138			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
139			}
140
141			public function testGetForecastUVIndex()
142			{
143			$owm = $this->openWeather;
144			foreach ($precisions as $precision) {
			0 ignored issues – show Bug introduced 2019-05-07 07:34 UTC by Report Bug Copy Issue Report The variable `$precisions` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
145			try {
146			$result = $owm->getForecastUVIndex(40.7, -74.2, 5);
147			} catch (Exception $e) {
148			// OWM might not actually have data for the timespan.
149			$this->assertSame('An error occurred: not found', $e->getMessage());
150			}
151			$this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
152			}
153			}
154
155			public function testGetHistoryUVIndex()
156			{
157			$owm = $this->openWeather;
158			foreach ($precisions as $precision) {
			0 ignored issues – show Bug introduced 2019-05-07 07:34 UTC by Report Bug Copy Issue Report The variable `$precisions` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
159			try {
160			$start = new \DateTime('1969-08-15');
161			$end = new \DateTime('1969-08-18');
162			$result = $owm->getForecastUVIndex(40.7, -74.2, null, $start, $end);
			0 ignored issues – show Unused Code introduced 2019-05-07 07:34 UTC by Report Bug Copy Issue Report The call to `OpenWeatherMap::getForecastUVIndex()` has too many arguments starting with `$start`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
163			} catch (Exception $e) {
164			// OWM might not actually have data for the timespan.
165			$this->assertSame('An error occurred: not found', $e->getMessage());
166			}
167			$this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
			0 ignored issues – show Bug introduced 2019-05-07 07:34 UTC by Report Bug Copy Issue Report The variable `$result` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
168			}
169			}
170
171			public function testGetDailyWeatherForecast()
172			{
173			$days = 16;
174			$dailyForecast = $this->owm->getDailyWeatherForecast('Berlin', 'imperial', 'en', '', $days);
175
176			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $dailyForecast);
177			}
178
179			public function testGetWeatherHistory()
180			{
181			$this->markTestSkipped('This getWeatherHistory method ignored because the api key need to have a paid permission.');
182			}
183
184			public function testWasCached()
185			{
186			$weather = $this->owm;
187			$result = $weather->wasCached();
188
189			$this->assertFalse($result);
190			}
191
192			public function testCached()
193			{
194			$cache = $this->cache;
195			$cache->setTempPath(__DIR__.'/temps');
196			$weather = new OpenWeatherMap($this->apiKey, new TestFetcher(), $cache, 600);
			0 ignored issues – show Documentation introduced 2017-01-02 13:31 UTC by Report Bug Copy Issue Report `$cache` is of type `object<Cmfcmf\OpenWeathe...erMap\ExampleCacheTest>`, but the function expects a `boolean\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
197			$currWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
198			$cachedWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
199
200			$this->assertInternalType('string', $currWeatherData);
201			$this->assertInternalType('string', $cachedWeatherData);
202			}
203
204			public function testBuildQueryUrlParameter()
205			{
206			$weather = $this->owm;
207			$queryWithNumbericArray = $weather->getWeather(array('2950159'), 'imperial', 'en', '');
208			$queryWithLatLonArray = $weather->getWeather(array('lat' => 52.524368, 'lon' => 13.410530), 'imperial', 'en', '');
209
210			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithNumbericArray);
211			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithLatLonArray);
212			}
213
214			public function testAbstractCache()
215			{
216			/** @var OpenWeatherMap\AbstractCache $sut */
217			$sut = $this->getMockForAbstractClass('\Cmfcmf\OpenWeatherMap\AbstractCache');
218			$this->assertNull($sut->setSeconds(10));
219			}
220			}
221

cmfcmf / OpenWeatherMap-PHP-API

Pull Request — master (#132)

OpenWeatherMapTest::testGetWeatherHistory() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like