Bad path generated through getScreenshotName

[thinkspill]

I was getting the following error:

Sorry, I couldn't compare screenshot "basicorderform","body":
ImagickException: Unable to write the file: /web/ee2/tests/_log/debug/tmp//web/ee2/tests/cart/BasicNewsTrialNewUser.basicorderform.png

Looking closely at the path you'll see /web/ee2/tests/ repeated twice. The first one is from Configuration::logDir() and the second one is being generated in VisualCeption::getScreenshotName.

That method calls $this->test->getFilename() to retrieve the test's filename, which is the source of the second path.

Removing $caseName from the return string fixes my basic test, but I'm not familiar enough with what other features this may affect that are looking for that screenshot name to be including a full path....

[phmLabs]

Hi, I changed some permissions and swiched from mkdir( $dir, 0666) to mkdir( $dir, 0777, true) can you verify the changes took effect?

[phmLabs]

Be careful. We changed the methods name to seeVisualChanges and dontSeeVisualChanges.

[thinkspill]

I don't think the problem is permissions. The problem is that $this->test->getFilename() is returning the full path to the test file, which you are then appending to the Codeception logDir which already contains the full path:

$logdir: /web/ee2/tests/_log/debug/tmp/
$testGetFileName: /web/ee2/tests/cart/BasicNewsTrialNewUserCept

You strip off the Cept, append a .png, and then concatenate the two strings, resulting in this:

/web/ee2/tests/_log/debug/tmp//web/ee2/tests/cart/BasicNewsTrialNewUser.basicorderform.png

My guess is a correct output for this would be:

/web/ee2/tests/_log/debug/tmp/BasicNewsTrialNewUser.basicorderform.png

[phmLabs]

Ok, now I the the problem. We have a flat structure in our test files at the moment, so we do not run into that problem.

I think we are able to remove the tmp image as it is not needed if you use the facebook webdriver executor directly. But we will run into the same problem when we store the reference or compare image.

We have to possible solutions:

• create the folders according to the project structure
• flatten the images names

What would be the prefered way?

[thinkspill]

If the goal is to generate a system-unique filename, converting all directory separators to underscores in GetScreenShotName might be sufficient.

[sebastianneubert]

Can I get your codeception.yml file?

[phmLabs]

The problem is that the getFileName method returns a relative path in our virtual machine and on travis ci.

[thinkspill]

Relevant sections of codeception.yml. Let me know if you're looking for another section.

paths:
    tests: tests
    log: tests/_log
    data: tests/_data
    helpers: tests/_helpers
settings:
    bootstrap: _bootstrap.php
    suite_class: \PHPUnit_Framework_TestSuite
    colors: true
    memory_limit: 2048M
    log: true
modules:
  config:
    VisualCeption:
      referenceImageDir: tests/referenceImages/
      maximumDeviation: 5

[phmLabs]

I guess I know why we can't reproduce your problem. You are using cests, right? We test cepts. That's why getFileName returns the classname in our case, but does returns the path in your test.

Tomorrow I will check my assumption.

[thinkspill]

No, I usually use Cepts:

/web/ee2/tests/cart/BasicNewsTrialNewUserCept.php for example.

Important to note is that I'm using the Codeception 2.0 beta. Maybe this is a change from 1.8.x. that it returns the full path.

[phmLabs]

Ok, I always confuse those two. We are using cests :)

[thinkspill]

Right, I'm using the single test file Cept format, rather than the class-based Cest format.

[thinkspill]

Interestingly, however, it is Cept.php you are removing from the filename inside getScreenshotName:

$caseName = str_replace('Cept.php', '', $this->test->getFileName());

If you all use Cest I'm surprised you're removing Cept here.

[phmLabs]

Damn. I created a Cept and the travis CI works like a charm.

https://travis-ci.org/DigitalProducts/codeception-module-visualception/jobs/21534609

Copying image (from /home/travis/build/DigitalProducts/codeception-module-
visualception/test/integration/tests/_log/debug/tmp/Simple.block.png to 
/home/travis/build/DigitalProducts/codeception-module-
visualception/test/integration/tests/_data/VisualCeption/Simple.block.png

I guess we have to check Codeception 2.0.