PidFileTestCase::lockedPidFile() - Code Metrics - Inspection of "refactor: less complexity by scrutinizer-ci.com" - danchukas/DenyMultiplyRun - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develope ( 2c1c90...4f785e )

by Anatoliy

created 2017-07-17 21:58 UTC

PidFileTestCase::lockedPidFile() A

↳ Parent: PidFileTestCase

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0

<?php
/**
 * Created by PhpStorm.
 * User: danchukas
 * Date: 2017-07-17 21:51
 */

namespace DanchukAS\DenyMultiplyRun;

use PHPUnit\Framework\TestCase;

/**
 * Class PidFileTestCase
 * included shared test settings.
 * @package DanchukAS\DenyMultiplyRunTest
 */
abstract class PidFileTestCase extends TestCase
{
    protected static $noExistFileName;

    protected static $existFileName;

    private static $tempFileList = [];

    public function setUp()
    {
        self::$noExistFileName = self::getFileName();
        self::$existFileName = self::newTempFileName();
    }

    /**
     * @return string
     */
    private static function getFileName(): string
    {
        $file_name = sys_get_temp_dir() . '/' . uniqid('vd_', true);
        self::$tempFileList[] = $file_name;
        return $file_name;
    }

    /**
     * @return bool|string
     */
    private static function newTempFileName()
    {
        $file_name = tempnam(sys_get_temp_dir(), 'vo_');
        self::$tempFileList[] = $file_name;
        return $file_name;
    }

    public function tearDown()
    {
        foreach (self::$tempFileList as $file_name) {
            /** @noinspection PhpUsageOfSilenceOperatorInspection */
            @unlink($file_name);
            /** @scrutinizer ignore-unhandled */ @unlink($file_name);
        }
    }

    /**
     * @return array
     */
    public function notFileNameProvider()
    {
        static $not_file_name = null;

        if (is_null($not_file_name)) {
            $not_file_name = $this->notStringProvider() + $this->noValidFileNameProvider();
        }

        return $not_file_name;
    }

    /**
     * @return array
     */
    public function notStringProvider()
    {
        static $not_string_list = null;
        if (is_null($not_string_list)) {
            $right_resource = fopen(__FILE__, "r");
            fclose($right_resource);
            $fail_resource = $right_resource;

            $not_string_list = [
                "null" => [null]
                , "boolean" => [false]
                , "int" => [0]
                , "array" => [[]]
                , "function" => [function () {
                }]
                , "object" => [new \Exception]
                , "resource" => [$fail_resource]
            ];

            foreach ($not_string_list as &$param) {
                $param["throw"] = "TypeError";
            }
        }

        return $not_string_list;
    }

    /**
     * @return array
     */
    public function noValidFileNameProvider()
    {
        static $file_name_list = null;

        if (is_null($file_name_list)) {
            $file_name_list = [
                [""]
                , ["."]
                , ["/"]
                , ['//']
            ];

            foreach ($file_name_list as &$param) {
                $param["throw"] = "Exception";
            }
        }

        return $file_name_list;
    }

    /**
     * return array
     */
    public function deletePidFileParam()
    {
        static $param = null;

        if (is_null($param)) {
            // existed file without write access for current user.
            // for Ubuntu is /etc/hosts.
            $file_name = "/etc/hosts";

            $message = $this->sudoOrNotUnix($file_name);

            $param = [
                "noExistFileName" => [self::getFileName()]
                , "wrongParam" => [null]
                , "accessDenied" => [$file_name, $message]
            ];
        }

        return $param;
    }

    /**
     * @param $file_name
     * @return null|string
     */
    private function sudoOrNotUnix($file_name)
    {
        $message = null;

        if (!file_exists($file_name)) {
            $message = "test only for *nix.";
        } elseif (is_writable($file_name)) {
            $message = "test runned under super/admin user. Change user.";
        }
        return $message;
    }

    /**
     * return array
     */
    public function setPidFileParam()
    {
        static $param = null;

        if (is_null($param)) {
            $param = [
                "lockedPidFile" => [
                    self::lockedPidFile()
                    , "DanchukAS\DenyMultiplyRun\Exception\LockFileFail"
                ]
                , "fileHasExistPid" => [
                    self::fileWithExistedPid()
                    , "DanchukAS\DenyMultiplyRun\Exception\ProcessExisted"
                ]
            ];
        }

        return $param;
    }

    /**
     *
     */
    private static function lockedPidFile()
    {
        while (true) {
            $file_name = self::newTempFileName();
            $file_resource = fopen($file_name, "r+");
            flock($file_resource, LOCK_EX);

            yield $file_name;
        }
    }

    /**
     *
     */
    private static function fileWithExistedPid()
    {
        while (true) {
            $file_name = self::newTempFileName();
            file_put_contents($file_name, getmypid());

            yield $file_name;
        }
    }
}


danchukas / DenyMultiplyRun

Push — develope ( 2c1c90...4f785e )

PidFileTestCase::lockedPidFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like