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

Question

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さんのご指摘を反映しました。

Answer 1

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に返り値が無いですね。

Comments

[Moffer]

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

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

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

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

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

[nnssn]

先の回答は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ファイルを書く、などでしょうか。

[nnssn]

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

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