TestCase::checkSkip() - Code Metrics - Inspection of "updated examples in README" - konecnyjakub/mytester - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 90f4ed...0dcbda )

by Jakub

created 2020-02-26 12:53 UTC

TestCase::checkSkip() B

↳ Parent: TestCase

Complexity

Conditions	11
Paths	7

Size

Total Lines	29
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	1

Metric	Value
cc	11
eloc	21
c	7
b	0
f	1
nc	7
nop	1
dl	0
loc	29
rs	7.3166

How to fix Complexity

<?php
declare(strict_types=1);

namespace MyTester;

/**
 * One test suit
 *
 * @author Jakub Konečný
 */
abstract class TestCase {
  use \Nette\SmartObject;
  
  public const METHOD_PATTERN = '#^test[A-Z0-9_]#';
  
  /**
   * Check whether to skip a test method
   *
   * @return bool|string
   */
  protected function checkSkip(\Nette\Reflection\Method $method) {

    if(!$method->hasAnnotation("skip")) {
      return false;
    }
    $value = $method->getAnnotation("skip");
    if(is_scalar($value)) {

      return (bool) $value;
    } elseif($value instanceof \Nette\Utils\ArrayHash) {
      foreach($value as $k => $v) {
        switch($k) {
          case "php":
            if(version_compare(PHP_VERSION, (string) $v, "<")) {
              return "PHP version is lesser than $v";
            }
            break;
          case "extension":
            if(!extension_loaded($v)) {
              return "extension $v is not loaded";
            }
            break;
          case "sapi":
            if(PHP_SAPI != $v) {
              return "the sapi is not $v";
            }
            break;
        }
      }
    }
    return false;
  }
  
  /**
   * Get list of jobs with parameters for current test suit
   * 
   * @return Job[]
   */
  protected function getJobs(): array {
    $jobs = [];
    $r = new \Nette\Reflection\ClassType(get_class($this));
    $methods = array_values(preg_grep(static::METHOD_PATTERN, array_map(function(\ReflectionMethod $rm) {
      return $rm->getName();
    }, $r->getMethods())));
    foreach($methods as $method) {
      $rm = $r->getMethod($method);
      $data = [];
      /** @var callable $callback */
      $callback = [$this, $method];
      $job = [
        "name" => $this->getJobName($rm), "callback" => $callback, "params" => [], "skip" => $this->checkSkip($rm), "shouldFail" => $rm->hasAnnotation("fail")

      ];
      if($rm->getNumberOfParameters() && $rm->hasAnnotation("data")) {
        $data = (array) $rm->getAnnotation("data");
      }
      if(count($data) > 0) {
        foreach($data as $value) {
          $job["params"][0] = $value;
          $jobs[] = new Job($job["name"], $job["callback"], $job["params"], $job["skip"], $job["shouldFail"]);
          $job["params"] = [];
        }
      } else {
        $jobs[] = new Job($job["name"], $job["callback"], $job["params"], $job["skip"], $job["shouldFail"]);
      }
    }
    return $jobs;
  }
  
  /**
   * Get name of current test suit
   */
  protected function getSuitName(): string {
    $suitName = get_class($this);
    $r = new \Nette\Reflection\ClassType($suitName);
    if($r->hasAnnotation("testSuit")) {
      $suitName = (string) $r->getAnnotation("testSuit");
    }
    return $suitName;
  }
  
  /**
   * Get name for a job
   */
  protected function getJobName(\Nette\Reflection\Method $method): string {
    if($method->hasAnnotation("test")) {
      return (string) $method->getAnnotation("test");
    }
    return $this->getSuitName() . "::" . $method->getName();
  }
  
  /**
   * Called at start of the suit
   */
  public function startUp(): void {
  }
  
  /**
   * Called at end of the suit
   */
  public function shutDown(): void {
  }
  
  /**
   * Called before each job
   */
  public function setUp(): void {
  }
  
  /**
   * Called after each job
   */
  public function tearDown(): void {
  }
  
  protected function runJob(Job $job): string {
    /** @var array $callback */
    $callback = $job->callback;
    $jobName = $this->getJobName(\Nette\Reflection\Method::from($callback[0], $callback[1]));
    Environment::$currentJob = $jobName;
    if(!$job->skip) {
      $this->setUp();
    }
    $job->execute();
    if(!$job->skip) {
      $this->tearDown();
    }
    Environment::$currentJob = "";
    switch($job->result) {
      case "passed":
        return ".";
      case "skipped":
        return "s";
      case "failed":
        return "F";
    }
    return "";
  }
  
  /**
   * Runs the test suit
   */
  public function run(): bool {
    $this->startUp();
    $jobs = $this->getJobs();
    $output = "";
    $passed = true;
    foreach($jobs as $job) {
      $output .= $this->runJob($job);
      if($job->result === "failed") {
        $passed = false;
      }
    }
    $this->shutDown();
    echo $output;
    return $passed;
  }
}
?>

1			<?php
2			declare(strict_types=1);
3
4			namespace MyTester;
5
6			/**
7			* One test suit
8			*
9			* @author Jakub Konečný
10			*/
11			abstract class TestCase {
12			use \Nette\SmartObject;
13
14			public const METHOD_PATTERN = '#^test[A-Z0-9_]#';
15
16			/**
17			* Check whether to skip a test method
18			*
19			* @return bool\|string
20			*/
21			protected function checkSkip(\Nette\Reflection\Method $method) {
			0 ignored issues – show introduced 2020-02-26 12:56 UTC by Report Bug Copy Issue Report Function's cyclomatic complexity (11) exceeds 10; consider refactoring the function Loading history...
22			if(!$method->hasAnnotation("skip")) {
23			return false;
24			}
25			$value = $method->getAnnotation("skip");
26			if(is_scalar($value)) {
			0 ignored issues – show introduced 2019-03-03 18:42 UTC by Report Bug Copy Issue Report The condition `is_scalar($value)` is always `false`. Loading history...
27			return (bool) $value;
28			} elseif($value instanceof \Nette\Utils\ArrayHash) {
29			foreach($value as $k => $v) {
30			switch($k) {
31			case "php":
32			if(version_compare(PHP_VERSION, (string) $v, "<")) {
33			return "PHP version is lesser than $v";
34			}
35			break;
36			case "extension":
37			if(!extension_loaded($v)) {
38			return "extension $v is not loaded";
39			}
40			break;
41			case "sapi":
42			if(PHP_SAPI != $v) {
43			return "the sapi is not $v";
44			}
45			break;
46			}
47			}
48			}
49			return false;
50			}
51
52			/**
53			* Get list of jobs with parameters for current test suit
54			*
55			* @return Job[]
56			*/
57			protected function getJobs(): array {
58			$jobs = [];
59			$r = new \Nette\Reflection\ClassType(get_class($this));
60			$methods = array_values(preg_grep(static::METHOD_PATTERN, array_map(function(\ReflectionMethod $rm) {
61			return $rm->getName();
62			}, $r->getMethods())));
63			foreach($methods as $method) {
64			$rm = $r->getMethod($method);
65			$data = [];
66			/** @var callable $callback */
67			$callback = [$this, $method];
68			$job = [
69			"name" => $this->getJobName($rm), "callback" => $callback, "params" => [], "skip" => $this->checkSkip($rm), "shouldFail" => $rm->hasAnnotation("fail")
			0 ignored issues – show introduced 2020-02-06 20:22 UTC by Report Bug Copy Issue Report Line exceeds 120 characters; contains 158 characters Loading history...
70			];
71			if($rm->getNumberOfParameters() && $rm->hasAnnotation("data")) {
72			$data = (array) $rm->getAnnotation("data");
73			}
74			if(count($data) > 0) {
75			foreach($data as $value) {
76			$job["params"][0] = $value;
77			$jobs[] = new Job($job["name"], $job["callback"], $job["params"], $job["skip"], $job["shouldFail"]);
78			$job["params"] = [];
79			}
80			} else {
81			$jobs[] = new Job($job["name"], $job["callback"], $job["params"], $job["skip"], $job["shouldFail"]);
82			}
83			}
84			return $jobs;
85			}
86
87			/**
88			* Get name of current test suit
89			*/
90			protected function getSuitName(): string {
91			$suitName = get_class($this);
92			$r = new \Nette\Reflection\ClassType($suitName);
93			if($r->hasAnnotation("testSuit")) {
94			$suitName = (string) $r->getAnnotation("testSuit");
95			}
96			return $suitName;
97			}
98
99			/**
100			* Get name for a job
101			*/
102			protected function getJobName(\Nette\Reflection\Method $method): string {
103			if($method->hasAnnotation("test")) {
104			return (string) $method->getAnnotation("test");
105			}
106			return $this->getSuitName() . "::" . $method->getName();
107			}
108
109			/**
110			* Called at start of the suit
111			*/
112			public function startUp(): void {
113			}
114
115			/**
116			* Called at end of the suit
117			*/
118			public function shutDown(): void {
119			}
120
121			/**
122			* Called before each job
123			*/
124			public function setUp(): void {
125			}
126
127			/**
128			* Called after each job
129			*/
130			public function tearDown(): void {
131			}
132
133			protected function runJob(Job $job): string {
134			/** @var array $callback */
135			$callback = $job->callback;
136			$jobName = $this->getJobName(\Nette\Reflection\Method::from($callback[0], $callback[1]));
137			Environment::$currentJob = $jobName;
138			if(!$job->skip) {
139			$this->setUp();
140			}
141			$job->execute();
142			if(!$job->skip) {
143			$this->tearDown();
144			}
145			Environment::$currentJob = "";
146			switch($job->result) {
147			case "passed":
148			return ".";
149			case "skipped":
150			return "s";
151			case "failed":
152			return "F";
153			}
154			return "";
155			}
156
157			/**
158			* Runs the test suit
159			*/
160			public function run(): bool {
161			$this->startUp();
162			$jobs = $this->getJobs();
163			$output = "";
164			$passed = true;
165			foreach($jobs as $job) {
166			$output .= $this->runJob($job);
167			if($job->result === "failed") {
168			$passed = false;
169			}
170			}
171			$this->shutDown();
172			echo $output;
173			return $passed;
174			}
175			}
176			?>

konecnyjakub / mytester

Push — master ( 90f4ed...0dcbda )

TestCase::checkSkip() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like