質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.93%

Codeceptionでグローバル変数を使用したい(PHP)

受付中

回答 1

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 1,615

score 10

Codeceptionを試しに使用しているのですが、グローバル変数の扱いで困っています。Unitテストにおいてグローバル変数は使用できないのでしょうか?

すでにある既存システムのテストコードを書こうとしているので、あまり既存システムに手を入れたくないものでして、テストコード側で解決できる方法を探しています。

以下は単純化したコードです。

該当のソースコード

<?php
//--------------------
//global.php
//--------------------
$garray = [1,2,3,4,5];
<?php
//--------------------
//app.php
//--------------------
include_once('global.php');

function putarray($i){
    global $garray;
    echo $garray[$i];
    return($garray[$i]);
}
<?php
//--------------------
// tests/unit/appTest.php 
//--------------------
require_once('app.php');

class appTest extends \PHPUnit_Framework_TestCase
{
    protected function setUp(){
        ;
    }

    protected function tearDown(){
        ;
    }

    // tests
    public function testMe(){
        $this->assertTrue(putarray(1)===2);
    }
}

実行結果

$ codecept run
Codeception PHP Testing Framework v2.1.8
Powered by PHPUnit 5.3.2 by Sebastian Bergmann and contributors.

Acceptance Tests (0) ------------------------
---------------------------------------------

Functional Tests (0) ------------------------
---------------------------------------------

Unit Tests (1) ------------------------------
appTest::testMe                        Fail
---------------------------------------------


Time: 241 ms, Memory: 10.50Mb

There was 1 failure:

---------
1) appTest::testMe
Failed asserting that false is true.
#1  /home/ubuntu/test/tests/unit/appTest.php:18
#2  appTest->testMe
#3  /usr/local/bin/codecept:7

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

環境

$ codecept --version
Codeception version 2.1.8

$ php --version
PHP 5.5.9-1ubuntu4.14 (cli) (built: Oct 28 2015 01:34:46) 
Copyright (c) 1997-2014 The PHP Group
Zend Engine v2.5.0, Copyright (c) 1998-2014 Zend Technologies
    with Zend OPcache v7.0.3, Copyright (c) 1999-2014, by Zend Technologies
    with Xdebug v2.4.0, Copyright (c) 2002-2016, by Derick Rethans

以上です。
よろしくお願いいたします。

 追記

5/29 nnssnさんのご指摘を反映しました。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

0

require_onceの位置が問題のようです。
require_once('app.php')で読み込まれるのは変数$garrayと関数putarrayですが、
これをクラスメソッド内で呼び出した時(appTest::setUpの中ですね)、
関数putarrayはグローバル関数に、変数$garrayはappTest::setUp内のローカル変数に
なっています。どちらもグロバールスコープに配置するとしたら、require_onceの位置は
メソッドの(というかクラスの)外、

require_once('app.php');

class appTest extends \PHPUnit_Framework_TestCase

こちらならうまくいくはずです。

気になったのでnamespaceを付けてTest\putarray()としたり、Test2\appTestとしたりして
メソッド内でrequireしてみましたが、その場合はnamespaceを引き継いで
Test\putarray()、Test2\putarray()になるようです。
変数は名前空間の影響を受けないので普通にローカル変数になりました。

あと、実際のコードとは関係ないと思うのですが
putarrayに返り値が無いですね。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/05/29 18:17 編集

    ご回答ありがとうございます。
    return付与、include_onceの位置変更を行いましたが、やはり状況は変わらず…でした。

    ちなみに、testMe内で以下のテストを実施したところ、

     global $garray;
     $this->assertTrue( array_key_exists('garray', $GLOBALS) ); //テスト通る(上の行globalの影響?)
     $this->assertTrue( is_array($GLOBALS['garray']) ); //テスト通らない

    となったので、うまいこと$garrayがrequireできていないのでは…という印象です。

    素のPHPUnitだとすんなり行ってくれるので、何が原因なんだろうといった心境です。公式ドキュメントも見ているのですが、特にグローバル変数についての記述も見当たらず…。

    キャンセル

  • 2016/05/29 20:54

    先の回答はPHPUnitで試したものだったので、Codeceptionをインストールして
    改めて確認してみました。Codeceptionを通すとダメでした。

    処理の始点のcodeceptを確認すると、始まりから終わりまで完全に
    クラスベースで実装されていました。これはテスト内のどのタイミングで
    変数の入ったファイルを読み込んだとしても、どこかのメソッドの
    ローカル変数になってしまうということだと思います。

    codecept
    https://github.com/Codeception/Codeception/blob/2.1/codecept

    Command/Run
    https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Command/Run.php

    グローバル変数を使う方向で進めるなら、global.phpをcodeceptの影響の外に置く
    必要がありそうです。一番雑で手軽なのはcodeceptの先頭に
    require_once('global.php')を追記する方法で、これは実際に試して出来ました。
    きちんとするなら「global.phpを読み込んでから、codeceptに実行する」
    phpファイルを書く、などでしょうか。

    キャンセル

  • 2016/05/29 20:59

    > global $garray;
    >  $this->assertTrue( array_key_exists('garray', $GLOBALS) ); //テスト通る(上の行globalの影響?)

    これは$garray;が存在しない状態で、global $garray;を宣言すると
    $garrayがnullで定義されてしまうからだと思います。結構な罠ですね。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.93%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る