io.vrap.codegen.languages.php.test.PhpTestRenderer.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of php Show documentation
RAML API client code generators based on the REST Modeling Framework. https://github.com/vrapio/rest-modeling-framework
The newest version!
package io.vrap.codegen.languages.php.test

import com.damnhandy.uri.template.UriTemplate
import io.vrap.codegen.languages.extensions.getMethodName
import io.vrap.codegen.languages.php.AbstractRequestBuilder
import io.vrap.codegen.languages.php.ClientConstants
import io.vrap.codegen.languages.php.PhpSubTemplates
import io.vrap.codegen.languages.php.extensions.forcedLiteralEscape
import io.vrap.codegen.languages.php.extensions.paramValues
import io.vrap.codegen.languages.php.extensions.resourcePathList
import io.vrap.codegen.languages.php.extensions.toNamespaceName
import io.vrap.rmf.codegen.io.TemplateFile
import io.vrap.rmf.codegen.rendering.FileProducer
import io.vrap.rmf.codegen.rendering.utils.escapeAll
import io.vrap.rmf.codegen.rendering.utils.keepAngleIndent
import io.vrap.rmf.codegen.types.VrapTypeProvider
import io.vrap.rmf.raml.model.modules.Api
import io.vrap.rmf.raml.model.resources.Resource
import io.vrap.rmf.raml.model.types.StringInstance
import io.vrap.rmf.raml.model.util.StringCaseFormat

class PhpTestRenderer constructor(api: Api, vrapTypeProvider: VrapTypeProvider, clientConstants: ClientConstants) : FileProducer, AbstractRequestBuilder(api, vrapTypeProvider, clientConstants) {

    override fun produceFiles(): List = listOf(
            configTest(),
            rootResourceTest(api)
    )

    private fun configTest(): TemplateFile {
        val clientTestPackageName = basePackagePrefix + "/test" + clientPackageName.replace(basePackagePrefix, "")
        val baseUri = when (val sdkBaseUri = api.getAnnotation("sdkBaseUri")?.value) {
            is StringInstance -> UriTemplate.fromTemplate(sdkBaseUri.value)
            else -> api.baseUri.value
        }

        return TemplateFile(relativePath = "test/unit/Client/ConfigTest.php",
                content = """
                    |getApiUri());
                    |        self::assertSame($!expectedUri, $!c->getOptions()[Config::OPT_BASE_URI]);
                    |    }
                    |
                    |    public function testBaseUri()
                    |    {
                    |        $!c = new Config(${if (baseUri.variables.isNotEmpty()) { baseUri.testParams().joinToString(", ", postfix = ", ") } else ""}[], "baseUri");
                    |        self::assertSame("baseUri", $!c->getApiUri());
                    |        self::assertSame("baseUri", $!c->getOptions()[Config::OPT_BASE_URI]);
                    |    }
                    |
                    |    public function testOptionsBaseUri()
                    |    {
                    |        $!c = new Config(${if (baseUri.variables.isNotEmpty()) { baseUri.testParams().joinToString(", ", postfix = ", ") } else ""}[Config::OPT_BASE_URI => "optBaseUri"], "baseUri");
                    |        self::assertSame("baseUri", $!c->getApiUri());
                    |        self::assertSame("optBaseUri", $!c->getOptions()[Config::OPT_BASE_URI]);
                    |    }
                    |}
                """.trimMargin().keepAngleIndent().forcedLiteralEscape())
    }

    private fun UriTemplate.testParams(): List = variables.map {
        "\"test_${StringCaseFormat.LOWER_CAMEL_CASE.apply(it)}\""
    }

    private fun rootResourceTest(type: Api): TemplateFile {
        val rootResource = type.resources.firstOrNull { resource -> resource.resourcePath == "/" }
        val clientTestPackageName = basePackagePrefix + "/test" + clientPackageName.replace(basePackagePrefix, "")
        val resources = if (rootResource != null && type.resources.size == 1) rootResource.resources else type.resources

        return TemplateFile(relativePath = "test/unit/Client/${rootResource()}Test.php",
                content = """
                    |>
                    |use ${clientPackageName.toNamespaceName().escapeAll()}\\${rootResource()};
                    |use PHPUnit\\Framework\\TestCase;
                    |use GuzzleHttp\\ClientInterface;
                    |
                    |class ${rootResource()}Test extends TestCase
                    |{
                    |    public function testConstruct()
                    |    {
                    |        $!client = $!this->createMock(ClientInterface::class);
                    |        $!root = new ${rootResource()}($!client);
                    |        $!this->assertInstanceOf(ClientInterface::class, $!root->getClient());
                    |        $!this->assertSame('', $!root->getUri());
                    |    }
                    |    
                    |    /**
                    |     * @dataProvider getResources()
                    |     */
                    |    public function testResources(callable $!builderFunction, string $!class, array $!expectedArgs)
                    |    {
                    |        $!builder = new ${rootResource()}();
                    |        $!resource = $!builderFunction($!builder);
                    |        $!this->assertInstanceOf($!class, $!resource);
                    |        $!this->assertEquals($!expectedArgs, $!resource->getArgs());
                    |    }
                    |    
                    |    public function getResources()
                    |    {
                    |        return [
                    |            <<${resources.map { resourceTestProvider(it) }.joinToString(",\n")}>>
                    |        ];
                    |    }
                    |}
                """.trimMargin().keepAngleIndent().forcedLiteralEscape())
    }

    private fun resourceTestProvider(resource: Resource): String {
        val builderChain = resource.resourcePathList().map { r -> "${r.getMethodName()}(${if (r.relativeUri.paramValues().isNotEmpty()) "\"${r.relativeUri.paramValues().joinToString("\", \"") { p -> "test_$p"} }\"" else ""})" }

        return """
            |'${resource.resourceBuilderName()}' => [
            |    function (${rootResource()} $!builder): ${resource.resourceBuilderName()} {
            |        return $!builder
            |            <<${builderChain.joinToString("\n->", "->")}>>;
            |    },
            |    ${resource.resourceBuilderName()}::class,
            |    [${resource.fullUriParameters.joinToString(", ") { "'${it.name}' => 'test_${it.name}'" }}],
            |    '${resource.fullUri.template}'
            |]
        """.trimMargin()
    }
}