salesagility_SuiteCRM/tests/unit/phpunit/modules/Documents/DocumentTest.php

<?php

use SuiteCRM\Test\SuitePHPUnitFrameworkTestCase;

class DocumentTest extends SuitePHPUnitFrameworkTestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        global $current_user;
        get_sugar_config_defaults();
        $current_user = BeanFactory::newBean('Users');
    }

    public function testDocument(): void
    {
        // Execute the constructor and check for the Object type and  attributes
        $document = BeanFactory::newBean('Documents');
        self::assertInstanceOf('Document', $document);
        self::assertInstanceOf('File', $document);
        self::assertInstanceOf('SugarBean', $document);

        self::assertEquals('Documents', $document->module_dir);
        self::assertEquals('Document', $document->object_name);
        self::assertEquals('documents', $document->table_name);
        self::assertEquals(true, $document->new_schema);
        self::assertEquals(false, $document->disable_row_level_security);
    }

    public function testSaveAndGet_document_name(): void
    {
        $document = BeanFactory::newBean('Documents');

        $document->filename = 'test';
        $document->file_url = 'test_url';
        $document->file_url_noimage = 'test_image_url';
        $document->last_rev_created_name = 'test';
        $document->category_id = '1';
        $document->subcategory_id = '1';
        $document->document_name = 'test';

        $document->save();

        //test for record ID to verify that record is saved
        self::assertTrue(isset($document->id));
        self::assertEquals(36, strlen((string) $document->id));

        //execute Get_document_name() method and verify it gets the name correctly
        self::assertEquals(null, $document->get_document_name(1));
        self::assertEquals('test', $document->get_document_name($document->id));

        //mark the record as deleted and verify that this record cannot be retrieved anymore.
        $document->mark_deleted($document->id);
        $result = $document->retrieve($document->id);
        self::assertEquals(null, $result);
    }

    public function testget_summary_text(): void
    {
        $document = BeanFactory::newBean('Documents');

        //test without setting name
        self::assertEquals(null, $document->get_summary_text());

        //test with name set
        $document->document_name = 'test';
        self::assertEquals('test', $document->get_summary_text());
    }

    public function testis_authenticated(): void
    {
        $document = BeanFactory::newBean('Documents');

        //test without presetting attributes
        self::assertEquals(null, $document->is_authenticated());

        //test with attributes preset
        $document->authenticated = true;
        self::assertEquals(true, $document->is_authenticated());
    }

    public function testfill_in_additional_list_fields(): void
    {
        $document = BeanFactory::newBean('Documents');

        // Execute the method and test that it works and doesn't throw an exception.
        try {
            $document->fill_in_additional_list_fields();
            self::assertTrue(true);
        } catch (Exception $e) {
            self::fail($e->getMessage() . "\nTrace:\n" . $e->getTraceAsString());
        }
    }

    public function testfill_in_additional_detail_fields(): void
    {
        self::markTestIncomplete('environment dependency (random generated token in url)');

        $document = BeanFactory::newBean('Documents');
        $document->id = 'abcde-12345';

        //execute the method with attributes preset and verify attributes are set accordingly
        $document->fill_in_additional_detail_fields();

        // test the urls instead of the a tag itself
        self::assertEquals('', $document->file_url, 'file url: [[' . $document->file_url . ']]');
        //
        self::assertEquals('', $document->file_url_noimage, 'file url noimage: [[' . $document->file_url_noimage . ']]');
    }

    public function testlist_view_parse_additional_sections(): void
    {
        $document = BeanFactory::newBean('Documents');

        $xTemplateSection = null;

        // Execute the method and test that it works and doesn't throw an exception.
        try {
            $ss = new Sugar_Smarty();
            $document->list_view_parse_additional_sections($ss, $xTemplateSection);
            self::assertTrue(true);
        } catch (Exception $e) {
            self::fail($e->getMessage() . "\nTrace:\n" . $e->getTraceAsString());
        }
    }

    public function testcreate_export_query(): void
    {
        self::markTestIncomplete('environment dependency');

        $document = BeanFactory::newBean('Documents');

        //test with empty string parameters
        $expected = "SELECT\n						documents.* FROM documents  WHERE  documents.deleted = 0 ORDER BY documents.document_name";
        $actual = $document->create_export_query('', '');
        self::assertSame($expected, $actual);

        //test with valid string parameters
        $expected = "SELECT\n						documents.* FROM documents  WHERE documents.document_name = \"\" AND  documents.deleted = 0 ORDER BY documents.id";
        $actual = $document->create_export_query('documents.id', 'documents.document_name = ""');
        self::assertSame($expected, $actual);
    }

    public function testget_list_view_data(): void
    {
        self::markTestIncomplete();

        $document = BeanFactory::newBean('Documents');
        // Execute the method and verify that it returns expected results

        $document->filename = 'test';
        $document->file_url = 'test_url';
        $document->file_url_noimage = 'test_image_url';
        $document->last_rev_created_name = 'test';
        $document->category_id = '1';
        $document->subcategory_id = '1';
        $document->document_name = 'test';

        $expected = array(
                'DELETED' => 0,
                'DOCUMENT_NAME' => 'test',
                'DOC_TYPE' => 'Sugar',
                'FILENAME' => 'test',
                'ACTIVE_DATE' => $document->active_date,
                'CATEGORY_ID' => null,
                'SUBCATEGORY_ID' => null,
                'REVISION' => '1',
                'LAST_REV_CREATED_NAME' => 'test',
                'IS_TEMPLATE' => '0',
                'FILE_URL' => '~'
                                .'<a href=\'index.php\?entryPoint=download\&id=\&type=Documents\' target=\'_blank\'><img src="themes/\w+/images/def_image_inline\.\w+\?v='
                                .'~',
                'FILE_URL_NOIMAGE' => 'index.php?entryPoint=download&type=Documents&id=',
                'LAST_REV_CREATED_BY' => 'test',
                'NAME' => 'test',
                'DOCUMENT_NAME_JAVASCRIPT' => null,
        );

        $actual = $document->get_list_view_data();
        foreach ($expected as $expectedKey => $expectedVal) {
            if ($expectedKey == 'FILE_URL') {
                self::assertMatchesRegularExpression($expected[$expectedKey], $actual[$expectedKey]);
            } else {
                self::assertSame($expected[$expectedKey], $actual[$expectedKey]);
            }
        }
    }

    public function testmark_relationships_deleted(): void
    {
        $document = BeanFactory::newBean('Documents');

        // Execute the method and test that it works and doesn't throw an exception.
        try {
            $document->mark_relationships_deleted(1);
            self::assertTrue(true);
        } catch (Exception $e) {
            self::fail($e->getMessage() . "\nTrace:\n" . $e->getTraceAsString());
        }
    }

    public function testbean_implements(): void
    {
        $document = BeanFactory::newBean('Documents');
        self::assertEquals(false, $document->bean_implements('')); //test with blank value
        self::assertEquals(false, $document->bean_implements('test')); //test with invalid value
        self::assertEquals(true, $document->bean_implements('ACL')); //test with valid value
    }
}