lang/php/test/NameTest.php

<?php

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Apache\Avro\Tests;

use Apache\Avro\Schema\AvroName;
use Apache\Avro\Schema\AvroSchemaParseException;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

class NameExample implements \Stringable
{
    public function __construct(public $name, public $namespace, public $default_namespace, public $is_valid, public $expected_fullname = null)
    {
    }

    public function __toString(): string
    {
        return var_export($this, true);
    }
}

class NameTest extends TestCase
{
    public static function fullname_provider(): array
    {
        $examples = [
            new NameExample('foo', null, null, true, 'foo'),
            new NameExample('foo', 'bar', null, true, 'bar.foo'),
            new NameExample('bar.foo', 'baz', null, true, 'bar.foo'),
            new NameExample('_bar.foo', 'baz', null, true, '_bar.foo'),
            new NameExample('bar._foo', 'baz', null, true, 'bar._foo'),
            new NameExample('3bar.foo', 'baz', null, false),
            new NameExample('bar.3foo', 'baz', null, false),
            new NameExample('b4r.foo', 'baz', null, true, 'b4r.foo'),
            new NameExample('bar.f0o', 'baz', null, true, 'bar.f0o'),
            new NameExample(' .foo', 'baz', null, false),
            new NameExample('bar. foo', 'baz', null, false),
            new NameExample('bar. ', 'baz', null, false),
        ];
        $exes = [];
        foreach ($examples as $ex) {
            $exes[] = [$ex];
        }

        return $exes;
    }

    #[DataProvider('fullname_provider')]
    public function test_fullname($ex): void
    {
        try {
            $name = new AvroName($ex->name, $ex->namespace, $ex->default_namespace);
            $this->assertTrue($ex->is_valid);
            $this->assertEquals($ex->expected_fullname, $name->fullname());
        } catch (AvroSchemaParseException $e) {
            $this->assertFalse($ex->is_valid, sprintf(
                "%s:\n%s",
                $ex,
                $e->getMessage()
            ));
        }
    }

    public static function name_provider(): array
    {
        return [
            ['a', true],
            ['_', true],
            ['1a', false],
            ['', false],
            [null, false],
            [' ', false],
            ['Cons', true],
        ];
    }

    #[DataProvider('name_provider')]
    public function test_name($name, $is_well_formed): void
    {
        $this->assertEquals(AvroName::isWellFormedName($name), $is_well_formed);
    }
}