testusecases.php

<?php
 
require_once 'lib/bagit.php';
 
class BagPhpUseCaseTest extends PHPUnit_Framework_TestCase
{
    var $to_rm;
 
    private function queueRm($dirname)
    {
        array_push($this->to_rm, $dirname);
    }
 
    public function setUp()
    {
        $this->to_rm = array();
    }
 
    public function tearDown()
    {
        foreach ($this->to_rm as $dirname)
        {
            rrmdir($dirname);
        }
    }
 
    public function testBagProducer()
    {
        $tmpdir = tmpdir();
        mkdir($tmpdir);
        $this->queueRm($tmpdir);
 
        $tmpbag = "$tmpdir/BagProducer";
 
        // 1. Create a new bag;
        $bag = new BagIt($tmpbag);
 
        $this->assertTrue($bag->isValid());
        $this->assertTrue($bag->isExtended());
 
        $bagInfo = $bag->getBagInfo();
        $this->assertEquals('0.96',  $bagInfo['version']);
        $this->assertEquals('UTF-8', $bagInfo['encoding']);
        $this->assertEquals('sha1',  $bagInfo['hash']);
 
        $this->assertEquals("$tmpbag/data", $bag->getDataDirectory());
        $this->assertEquals('sha1', $bag->getHashEncoding());
        $this->assertEquals(0, count($bag->getBagContents()));
        $this->assertEquals(0, count($bag->getBagErrors()));
 
        // 2. Add files to the bag;
        $srcdir = __DIR__ . '/TestBag/data';
        $bag->addFile("$srcdir/README.txt", 'data/README.txt');
        $bag->addFile("$srcdir/imgs/uvalib.png", 'data/payloads/uvalib.png');
        // This needs to add data/ to the beginning of the file.
        $bag->addFile(
            "$srcdir/imgs/fibtriangle-110x110.jpg",
            'payloads/fibtri.jpg'
        );
 
        // 3. Add fetch entries;
        $bag->fetch->add('http://www.scholarslab.org/', 'data/index.html');
 
        // 4. Update the bag; and
        $bag->update();
 
        // 5. Package the bag.
        $pkgfile = "$tmpdir/BagProducer.tgz";
        $bag->package($pkgfile);
 
        // Finally, we need to validate the contents of the package.
        $dest = new BagIt($pkgfile);
        $this->queueRm($dest->bagDirectory);
 
        // First, verify that the data files are correct.
        $this->assertEquals(
            "BagIt-Version: 0.96\n" .
            "Tag-File-Character-Encoding: UTF-8\n",
            file_get_contents($dest->bagitFile)
        );
 
        // Second, verify that everything was uncompressed OK.
        $dest->validate();
        $this->assertEquals(0, count($dest->bagErrors));
 
        // Now, check that the file was fetched.
        $dest->fetch->download();
        $this->assertFileExists("{$dest->bagDirectory}/data/index.html");
 
        // Also, check that fibtri.jpg was added in the data/ directory.
        $this->assertFalse(
            file_exists("{$dest->bagDirectory}/payloads/fibtri.jpg")
        );
        $this->assertFileExists("{$dest->bagDirectory}/data/payloads/fibtri.jpg");
 
    }
 
    public function testBagConsumer()
    {
        $srcbag = __DIR__ . '/TestBag.tgz';
 
        // 1. Open the bag;
        $bag = new BagIt($srcbag);
        $this->queueRm($bag->bagDirectory);
 
        $this->assertTrue($bag->isValid());
        $this->assertTrue($bag->isExtended());
 
        $bagInfo = $bag->getBagInfo();
        $this->assertEquals('0.96',  $bagInfo['version']);
        $this->assertEquals('UTF-8', $bagInfo['encoding']);
        $this->assertEquals('sha1',  $bagInfo['hash']);
 
        $this->assertEquals('sha1', $bag->getHashEncoding());
        $this->assertEquals(7, count($bag->getBagContents()));
        $this->assertEquals(0, count($bag->getBagErrors()));
 
        // 2. Validate the downloaded contents;
        $bag->validate();
        $this->assertEquals(0, count($bag->getBagErrors()));
 
        // 3. Fetch on-line items in the bag;
        $bag->fetch->download();
        $bag->update();
        $bag->validate();
        $this->assertEquals(8, count($bag->getBagContents()));
 
        // 4. Validate the bag's contents; and
        $this->assertEquals(0, count($bag->getBagErrors()));
 
        // 5. Copy items from the bag onto the local disk.
        $tmpdir = tmpdir();
        mkdir($tmpdir);
        $this->queueRm($tmpdir);
 
        foreach ($bag->getBagContents() as $bagFile)
        {
            $basename = basename($bagFile);
            copy($bagFile, "$tmpdir/$basename");
        }
 
        $this->assertEquals(
            count($bag->getBagContents()) + 2,
            count(scandir($tmpdir))
        );
        $this->assertEquals(
            count($bag->manifest->getData()) + 2,
            count(scandir($tmpdir))
        );
 
    }
 
}
 
?>