@shortlink-org/portolan 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +387 -0
- package/catalog/enum_test.go +46 -0
- package/catalog/model.go +932 -0
- package/catalog/roundtrip_test.go +185 -0
- package/catalog/via_test.go +38 -0
- package/cli/portolan.mjs +368 -0
- package/go.mod +14 -0
- package/go.sum +14 -0
- package/index.html +13 -0
- package/internal/commands/cargo.go +154 -0
- package/internal/commands/commands.go +143 -0
- package/internal/commands/commands_test.go +323 -0
- package/internal/commands/gradle.go +77 -0
- package/internal/commands/justfile.go +82 -0
- package/internal/commands/makefile.go +106 -0
- package/internal/commands/maven.go +93 -0
- package/internal/commands/packagejson.go +159 -0
- package/internal/commands/pyproject.go +169 -0
- package/internal/commands/taskfile.go +101 -0
- package/internal/commands/testdata/estate/.cargo/config.toml +7 -0
- package/internal/commands/testdata/estate/Makefile +33 -0
- package/internal/commands/testdata/estate/Taskfile.yml +21 -0
- package/internal/commands/testdata/estate/build.gradle.kts +21 -0
- package/internal/commands/testdata/estate/justfile +20 -0
- package/internal/commands/testdata/estate/package.json +13 -0
- package/internal/commands/testdata/estate/pom.xml +29 -0
- package/internal/commands/testdata/estate/pyproject.toml +27 -0
- package/internal/commands/testdata/estate/xtask/src/main.rs +27 -0
- package/internal/commands/testdata/golden/commands.json +305 -0
- package/internal/gohttp/analyze.go +2500 -0
- package/internal/gohttp/endpoints.go +1067 -0
- package/internal/gohttp/roots.go +320 -0
- package/internal/gohttp/typed.go +143 -0
- package/internal/goscan/constants.go +85 -0
- package/internal/goscan/goscan_test.go +227 -0
- package/internal/goscan/names.go +52 -0
- package/internal/goscan/parse_test.go +11 -0
- package/internal/goscan/source.go +36 -0
- package/internal/goscan/tree.go +155 -0
- package/internal/goscan/types.go +99 -0
- package/internal/wsdl/ids.go +127 -0
- package/internal/wsdl/ids_test.go +21 -0
- package/internal/wsdl/model.go +62 -0
- package/internal/wsdl/parse.go +920 -0
- package/internal/wsdl/parse_test.go +133 -0
- package/package.json +117 -0
- package/plugin/describe.go +107 -0
- package/plugin/describe_test.go +114 -0
- package/plugin/protocol.go +117 -0
- package/plugin/schematest/schematest.go +126 -0
- package/plugins/README.md +1160 -0
- package/plugins/extract-adr/describe.go +19 -0
- package/plugins/extract-adr/describe_test.go +11 -0
- package/plugins/extract-adr/extract.go +153 -0
- package/plugins/extract-adr/extract_test.go +350 -0
- package/plugins/extract-adr/history.go +99 -0
- package/plugins/extract-adr/main.go +65 -0
- package/plugins/extract-adr/options.schema.json +26 -0
- package/plugins/extract-adr/parse.go +642 -0
- package/plugins/extract-adr/parse_test.go +405 -0
- package/plugins/extract-asyncapi/describe.go +19 -0
- package/plugins/extract-asyncapi/describe_test.go +11 -0
- package/plugins/extract-asyncapi/extract.go +315 -0
- package/plugins/extract-asyncapi/extract_test.go +197 -0
- package/plugins/extract-asyncapi/main.go +48 -0
- package/plugins/extract-asyncapi/options.schema.json +26 -0
- package/plugins/extract-asyncapi/spec.go +151 -0
- package/plugins/extract-celery/README.md +169 -0
- package/plugins/extract-celery/extract.py +346 -0
- package/plugins/extract-celery/extract_test.py +192 -0
- package/plugins/extract-celery/main.py +66 -0
- package/plugins/extract-celery/options.py +31 -0
- package/plugins/extract-celery/options.schema.json +31 -0
- package/plugins/extract-celery/producers.py +156 -0
- package/plugins/extract-celery/routes_test.py +106 -0
- package/plugins/extract-commands/describe.go +19 -0
- package/plugins/extract-commands/describe_test.go +11 -0
- package/plugins/extract-commands/extract.go +79 -0
- package/plugins/extract-commands/extract_test.go +92 -0
- package/plugins/extract-commands/main.go +55 -0
- package/plugins/extract-commands/options.schema.json +20 -0
- package/plugins/extract-csr/avro.go +258 -0
- package/plugins/extract-csr/describe.go +19 -0
- package/plugins/extract-csr/describe_test.go +11 -0
- package/plugins/extract-csr/extract.go +338 -0
- package/plugins/extract-csr/extract_test.go +374 -0
- package/plugins/extract-csr/jsonschema.go +343 -0
- package/plugins/extract-csr/lock.go +25 -0
- package/plugins/extract-csr/main.go +84 -0
- package/plugins/extract-csr/options.schema.json +43 -0
- package/plugins/extract-csr/subject.go +102 -0
- package/plugins/extract-django/README.md +386 -0
- package/plugins/extract-django/apps.py +100 -0
- package/plugins/extract-django/auth.py +302 -0
- package/plugins/extract-django/auth_test.py +188 -0
- package/plugins/extract-django/clients.py +121 -0
- package/plugins/extract-django/contracts.py +458 -0
- package/plugins/extract-django/database.py +119 -0
- package/plugins/extract-django/domain.py +318 -0
- package/plugins/extract-django/events.py +86 -0
- package/plugins/extract-django/extract.py +601 -0
- package/plugins/extract-django/extract_test.py +397 -0
- package/plugins/extract-django/flows.py +1278 -0
- package/plugins/extract-django/flows_test.py +338 -0
- package/plugins/extract-django/ids.py +42 -0
- package/plugins/extract-django/ids_test.py +30 -0
- package/plugins/extract-django/lifecycle.py +222 -0
- package/plugins/extract-django/lifecycle_test.py +76 -0
- package/plugins/extract-django/main.py +66 -0
- package/plugins/extract-django/openapi.py +229 -0
- package/plugins/extract-django/openapi_test.py +60 -0
- package/plugins/extract-django/operations.py +96 -0
- package/plugins/extract-django/options.py +61 -0
- package/plugins/extract-django/options.schema.json +126 -0
- package/plugins/extract-django/routing.py +214 -0
- package/plugins/extract-django/routing_test.py +198 -0
- package/plugins/extract-django/serializers.py +558 -0
- package/plugins/extract-django/store.py +434 -0
- package/plugins/extract-django/transport.py +242 -0
- package/plugins/extract-flows/describe.go +19 -0
- package/plugins/extract-flows/describe_test.go +11 -0
- package/plugins/extract-flows/extract.go +91 -0
- package/plugins/extract-flows/main.go +45 -0
- package/plugins/extract-flows/options.schema.json +16 -0
- package/plugins/extract-flows/parse.go +593 -0
- package/plugins/extract-flows/parse_test.go +204 -0
- package/plugins/extract-glossary/describe.go +19 -0
- package/plugins/extract-glossary/describe_test.go +11 -0
- package/plugins/extract-glossary/extract.go +115 -0
- package/plugins/extract-glossary/extract_test.go +220 -0
- package/plugins/extract-glossary/main.go +59 -0
- package/plugins/extract-glossary/options.schema.json +21 -0
- package/plugins/extract-glossary/parse.go +214 -0
- package/plugins/extract-glossary/parse_test.go +203 -0
- package/plugins/extract-go/aggregate.go +214 -0
- package/plugins/extract-go/client.go +409 -0
- package/plugins/extract-go/client_test.go +266 -0
- package/plugins/extract-go/describe.go +19 -0
- package/plugins/extract-go/describe_test.go +11 -0
- package/plugins/extract-go/enum.go +195 -0
- package/plugins/extract-go/enum_test.go +82 -0
- package/plugins/extract-go/event.go +99 -0
- package/plugins/extract-go/extract.go +191 -0
- package/plugins/extract-go/extract_test.go +261 -0
- package/plugins/extract-go/flow.go +1441 -0
- package/plugins/extract-go/flow_test.go +609 -0
- package/plugins/extract-go/httpclient.go +174 -0
- package/plugins/extract-go/httpclient_test.go +296 -0
- package/plugins/extract-go/ids.go +92 -0
- package/plugins/extract-go/layout.go +225 -0
- package/plugins/extract-go/layout_test.go +125 -0
- package/plugins/extract-go/lifecycle.go +324 -0
- package/plugins/extract-go/lifecycle_test.go +108 -0
- package/plugins/extract-go/main.go +79 -0
- package/plugins/extract-go/operation.go +157 -0
- package/plugins/extract-go/options.schema.json +66 -0
- package/plugins/extract-go/source.go +316 -0
- package/plugins/extract-go/transport.go +321 -0
- package/plugins/extract-go/transport_test.go +145 -0
- package/plugins/extract-go/wiring.go +434 -0
- package/plugins/extract-go-nats/describe.go +19 -0
- package/plugins/extract-go-nats/describe_test.go +11 -0
- package/plugins/extract-go-nats/extract.go +177 -0
- package/plugins/extract-go-nats/extract_test.go +389 -0
- package/plugins/extract-go-nats/index.go +379 -0
- package/plugins/extract-go-nats/main.go +42 -0
- package/plugins/extract-go-nats/options.schema.json +21 -0
- package/plugins/extract-go-nats/resolve.go +161 -0
- package/plugins/extract-go-nats/sites.go +224 -0
- package/plugins/extract-graphql/describe.go +19 -0
- package/plugins/extract-graphql/describe_test.go +11 -0
- package/plugins/extract-graphql/extract.go +433 -0
- package/plugins/extract-graphql/extract_test.go +256 -0
- package/plugins/extract-graphql/ids.go +49 -0
- package/plugins/extract-graphql/lex.go +237 -0
- package/plugins/extract-graphql/main.go +51 -0
- package/plugins/extract-graphql/options.schema.json +31 -0
- package/plugins/extract-graphql/parse.go +621 -0
- package/plugins/extract-graphql/parse_test.go +122 -0
- package/plugins/extract-http-clients/describe.go +19 -0
- package/plugins/extract-http-clients/describe_test.go +11 -0
- package/plugins/extract-http-clients/extract.go +705 -0
- package/plugins/extract-http-clients/extract_test.go +1263 -0
- package/plugins/extract-http-clients/main.go +42 -0
- package/plugins/extract-http-clients/options.schema.json +33 -0
- package/plugins/extract-java/README.md +190 -0
- package/plugins/extract-java/build/org/portolan/extract/Catalog.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$2.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Call.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Client.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Route.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Domain$Aggregate.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Domain.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Events$Found.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Events.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Extract.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Binding.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Draft.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Frame.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Options.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Ids.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Json$Reader.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Json.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle$Move.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Main.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi$Operation.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi$Spec.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations$UseCase.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto$Rpc.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto$Service.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Builder.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Input.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Options.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source$Project.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source$Unit.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Transport$Endpoint.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Transport.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml$Line.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml$Reader.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml.class +0 -0
- package/plugins/extract-java/options.schema.json +70 -0
- package/plugins/extract-openapi/describe.go +19 -0
- package/plugins/extract-openapi/describe_test.go +11 -0
- package/plugins/extract-openapi/discover.go +243 -0
- package/plugins/extract-openapi/extract.go +526 -0
- package/plugins/extract-openapi/extract_test.go +545 -0
- package/plugins/extract-openapi/main.go +75 -0
- package/plugins/extract-openapi/options.schema.json +62 -0
- package/plugins/extract-openapi/spec.go +350 -0
- package/plugins/extract-project/README.md +22 -0
- package/plugins/extract-project/describe.go +19 -0
- package/plugins/extract-project/describe_test.go +11 -0
- package/plugins/extract-project/extract.go +221 -0
- package/plugins/extract-project/extract_test.go +109 -0
- package/plugins/extract-project/main.go +41 -0
- package/plugins/extract-project/options.schema.json +48 -0
- package/plugins/extract-proto/ast.go +125 -0
- package/plugins/extract-proto/consumes.go +77 -0
- package/plugins/extract-proto/describe.go +19 -0
- package/plugins/extract-proto/extract.go +293 -0
- package/plugins/extract-proto/extract_test.go +459 -0
- package/plugins/extract-proto/ids.go +89 -0
- package/plugins/extract-proto/ids_test.go +57 -0
- package/plugins/extract-proto/lex.go +285 -0
- package/plugins/extract-proto/main.go +100 -0
- package/plugins/extract-proto/module.go +120 -0
- package/plugins/extract-proto/options.schema.json +51 -0
- package/plugins/extract-proto/parse.go +720 -0
- package/plugins/extract-proto/parse_test.go +307 -0
- package/plugins/extract-proto/provides.go +236 -0
- package/plugins/extract-proto/resolve.go +222 -0
- package/plugins/extract-proto/resolve_test.go +119 -0
- package/plugins/extract-python-kafka/README.md +36 -0
- package/plugins/extract-python-kafka/extract.py +211 -0
- package/plugins/extract-python-kafka/extract_test.py +68 -0
- package/plugins/extract-python-kafka/main.py +59 -0
- package/plugins/extract-python-kafka/options.py +29 -0
- package/plugins/extract-python-kafka/options.schema.json +31 -0
- package/plugins/extract-redis/README.md +11 -0
- package/plugins/extract-redis/describe.go +19 -0
- package/plugins/extract-redis/describe_test.go +11 -0
- package/plugins/extract-redis/extract.go +183 -0
- package/plugins/extract-redis/extract_test.go +168 -0
- package/plugins/extract-redis/keyspaces.go +469 -0
- package/plugins/extract-redis/main.go +44 -0
- package/plugins/extract-redis/options.schema.json +30 -0
- package/plugins/extract-river/describe.go +19 -0
- package/plugins/extract-river/describe_test.go +11 -0
- package/plugins/extract-river/extract.go +507 -0
- package/plugins/extract-river/extract_test.go +132 -0
- package/plugins/extract-river/main.go +42 -0
- package/plugins/extract-river/options.schema.json +21 -0
- package/plugins/extract-rust/Cargo.lock +133 -0
- package/plugins/extract-rust/Cargo.toml +23 -0
- package/plugins/extract-rust/README.md +204 -0
- package/plugins/extract-rust/options.schema.json +65 -0
- package/plugins/extract-rust/rustfmt.toml +1 -0
- package/plugins/extract-sql/ddl.go +893 -0
- package/plugins/extract-sql/ddl_test.go +401 -0
- package/plugins/extract-sql/describe.go +19 -0
- package/plugins/extract-sql/describe_test.go +11 -0
- package/plugins/extract-sql/layout.go +221 -0
- package/plugins/extract-sql/layout_test.go +55 -0
- package/plugins/extract-sql/lineage.go +107 -0
- package/plugins/extract-sql/main.go +141 -0
- package/plugins/extract-sql/maps.go +564 -0
- package/plugins/extract-sql/maps_java.go +117 -0
- package/plugins/extract-sql/maps_rust.go +333 -0
- package/plugins/extract-sql/maps_rust_test.go +70 -0
- package/plugins/extract-sql/maps_test.go +204 -0
- package/plugins/extract-sql/maps_ts.go +398 -0
- package/plugins/extract-sql/maps_ts_test.go +136 -0
- package/plugins/extract-sql/options.schema.json +53 -0
- package/plugins/extract-sql/projection.go +70 -0
- package/plugins/extract-sql/projection_test.go +50 -0
- package/plugins/extract-sql/store.go +420 -0
- package/plugins/extract-sql/store_test.go +233 -0
- package/plugins/extract-sql/view.go +295 -0
- package/plugins/extract-ts/README.md +306 -0
- package/plugins/extract-ts/ast.test.ts +178 -0
- package/plugins/extract-ts/ast.ts +648 -0
- package/plugins/extract-ts/clients.ts +185 -0
- package/plugins/extract-ts/domain.ts +164 -0
- package/plugins/extract-ts/extract.test.ts +208 -0
- package/plugins/extract-ts/extract.ts +200 -0
- package/plugins/extract-ts/flows.ts +783 -0
- package/plugins/extract-ts/graphql.test.ts +73 -0
- package/plugins/extract-ts/graphql.ts +181 -0
- package/plugins/extract-ts/ids.test.ts +21 -0
- package/plugins/extract-ts/ids.ts +52 -0
- package/plugins/extract-ts/lifecycle.ts +138 -0
- package/plugins/extract-ts/main.ts +48 -0
- package/plugins/extract-ts/openapi.test.ts +64 -0
- package/plugins/extract-ts/openapi.ts +99 -0
- package/plugins/extract-ts/operations.ts +93 -0
- package/plugins/extract-ts/options.schema.json +96 -0
- package/plugins/extract-ts/source.test.ts +174 -0
- package/plugins/extract-ts/source.ts +465 -0
- package/plugins/extract-ts/transport.ts +147 -0
- package/plugins/extract-ts/tsconfig.json +13 -0
- package/plugins/extract-ts/wiring.ts +190 -0
- package/plugins/extract-watermill/describe.go +19 -0
- package/plugins/extract-watermill/describe_test.go +11 -0
- package/plugins/extract-watermill/extract.go +1228 -0
- package/plugins/extract-watermill/extract_test.go +234 -0
- package/plugins/extract-watermill/main.go +41 -0
- package/plugins/extract-watermill/options.schema.json +21 -0
- package/plugins/extract-wsdl/describe.go +19 -0
- package/plugins/extract-wsdl/describe_test.go +11 -0
- package/plugins/extract-wsdl/extract.go +148 -0
- package/plugins/extract-wsdl/extract_test.go +45 -0
- package/plugins/extract-wsdl/main.go +53 -0
- package/plugins/extract-wsdl/options.schema.json +59 -0
- package/plugins/fetch-bsr/auth.go +114 -0
- package/plugins/fetch-bsr/bsr.go +240 -0
- package/plugins/fetch-bsr/cache.go +66 -0
- package/plugins/fetch-bsr/describe.go +19 -0
- package/plugins/fetch-bsr/fetch.go +192 -0
- package/plugins/fetch-bsr/fetch_test.go +465 -0
- package/plugins/fetch-bsr/lock.go +71 -0
- package/plugins/fetch-bsr/main.go +117 -0
- package/plugins/fetch-bsr/options.schema.json +42 -0
- package/plugins/fetch-csr/auth.go +95 -0
- package/plugins/fetch-csr/cache.go +69 -0
- package/plugins/fetch-csr/describe.go +19 -0
- package/plugins/fetch-csr/describe_test.go +11 -0
- package/plugins/fetch-csr/fetch.go +254 -0
- package/plugins/fetch-csr/fetch_test.go +494 -0
- package/plugins/fetch-csr/lock.go +95 -0
- package/plugins/fetch-csr/main.go +122 -0
- package/plugins/fetch-csr/options.schema.json +42 -0
- package/plugins/fetch-csr/registry.go +209 -0
- package/plugins/fetch-git/cache.go +65 -0
- package/plugins/fetch-git/describe.go +19 -0
- package/plugins/fetch-git/describe_test.go +11 -0
- package/plugins/fetch-git/fetch.go +181 -0
- package/plugins/fetch-git/fetch_test.go +332 -0
- package/plugins/fetch-git/git.go +169 -0
- package/plugins/fetch-git/lock.go +72 -0
- package/plugins/fetch-git/main.go +127 -0
- package/plugins/fetch-git/offline.go +39 -0
- package/plugins/fetch-git/options.schema.json +42 -0
- package/plugins/fetch-git/pin.go +90 -0
- package/plugins/fetch-git/pin_test.go +74 -0
- package/plugins/gen-backstage/describe.go +17 -0
- package/plugins/gen-backstage/main.go +22 -0
- package/plugins/gen-backstage/options.schema.json +30 -0
- package/plugins/gen-backstage/plugin.go +473 -0
- package/plugins/gen-backstage/plugin_test.go +145 -0
- package/plugins/gen-backstage.wasm +0 -0
- package/plugins/gen-markdown/adr.go +162 -0
- package/plugins/gen-markdown/aggregate.go +362 -0
- package/plugins/gen-markdown/canonical.go +93 -0
- package/plugins/gen-markdown/context.go +90 -0
- package/plugins/gen-markdown/coverage_test.go +89 -0
- package/plugins/gen-markdown/describe.go +19 -0
- package/plugins/gen-markdown/describe_test.go +11 -0
- package/plugins/gen-markdown/external.go +71 -0
- package/plugins/gen-markdown/flow.go +277 -0
- package/plugins/gen-markdown/glossary.go +76 -0
- package/plugins/gen-markdown/glossary_test.go +148 -0
- package/plugins/gen-markdown/llms.go +302 -0
- package/plugins/gen-markdown/main.go +22 -0
- package/plugins/gen-markdown/markdown.go +254 -0
- package/plugins/gen-markdown/markdown_test.go +100 -0
- package/plugins/gen-markdown/module.go +107 -0
- package/plugins/gen-markdown/options.schema.json +16 -0
- package/plugins/gen-markdown/plugin.go +39 -0
- package/plugins/gen-markdown/quality_test.go +176 -0
- package/plugins/gen-markdown/redis_test.go +38 -0
- package/plugins/gen-markdown/render.go +344 -0
- package/plugins/gen-markdown/render_test.go +186 -0
- package/plugins/gen-markdown/service.go +456 -0
- package/plugins/gen-markdown/source.go +177 -0
- package/plugins/gen-markdown/store.go +201 -0
- package/plugins/gen-markdown.wasm +0 -0
- package/plugins/gen-mermaid/describe.go +17 -0
- package/plugins/gen-mermaid/main.go +22 -0
- package/plugins/gen-mermaid/options.schema.json +10 -0
- package/plugins/gen-mermaid/plugin.go +104 -0
- package/plugins/gen-mermaid/plugin_test.go +33 -0
- package/plugins/gen-mermaid.wasm +0 -0
- package/plugins/openapi/ids.go +261 -0
- package/plugins/openapi/ids_test.go +98 -0
- package/plugins/pyplugin/catalog.py +209 -0
- package/plugins/pyplugin/celery_conf.py +436 -0
- package/plugins/pyplugin/celery_tasks.py +76 -0
- package/plugins/pyplugin/kafka.py +570 -0
- package/plugins/pyplugin/names.py +38 -0
- package/plugins/pyplugin/protocol.py +79 -0
- package/plugins/pyplugin/source.py +285 -0
- package/plugins/verify-codeowners/describe.go +19 -0
- package/plugins/verify-codeowners/describe_test.go +11 -0
- package/plugins/verify-codeowners/main.go +75 -0
- package/plugins/verify-codeowners/match.go +85 -0
- package/plugins/verify-codeowners/match_test.go +47 -0
- package/plugins/verify-codeowners/options.schema.json +15 -0
- package/plugins/verify-codeowners/owners.go +164 -0
- package/plugins/verify-codeowners/owners_test.go +225 -0
- package/plugins/verify-codeowners/parse.go +90 -0
- package/plugins/verify-codeowners/parse_test.go +62 -0
- package/plugins/verify-otel/describe.go +19 -0
- package/plugins/verify-otel/describe_test.go +11 -0
- package/plugins/verify-otel/main.go +53 -0
- package/plugins/verify-otel/match.go +336 -0
- package/plugins/verify-otel/options.schema.json +30 -0
- package/plugins/verify-otel/otlp.go +200 -0
- package/plugins/verify-otel/verify.go +734 -0
- package/plugins/verify-otel/verify_test.go +460 -0
- package/portolan.json +1073 -0
- package/public/favicon.svg +12 -0
- package/schema/portolan.schema.json +2558 -0
- package/scripts/README.md +53 -0
- package/scripts/build-report.mjs +60 -0
- package/scripts/build-report.test.mjs +44 -0
- package/scripts/builtin-plugins.mjs +49 -0
- package/scripts/catalog-sources.mjs +67 -0
- package/scripts/diff.mjs +315 -0
- package/scripts/diff.test.mjs +151 -0
- package/scripts/forge-comment.mjs +144 -0
- package/scripts/forge-comment.test.mjs +151 -0
- package/scripts/forge-release.mjs +138 -0
- package/scripts/forge-release.test.mjs +106 -0
- package/scripts/forge.mjs +61 -0
- package/scripts/gen-likec4.mjs +854 -0
- package/scripts/gen-likec4.test.mjs +258 -0
- package/scripts/gen.mjs +603 -0
- package/scripts/generated-docs.test.mjs +66 -0
- package/scripts/local-api.mjs +1192 -0
- package/scripts/local-api.test.mjs +387 -0
- package/scripts/manifest.mjs +214 -0
- package/scripts/manifest.test.mjs +148 -0
- package/scripts/output-path.mjs +79 -0
- package/scripts/output-path.test.mjs +45 -0
- package/scripts/package-smoke.mjs +37 -0
- package/scripts/plugin-host.mjs +419 -0
- package/scripts/plugin-host.test.mjs +109 -0
- package/scripts/plugin-wasm-worker.mjs +34 -0
- package/scripts/run-builtin.mjs +81 -0
- package/scripts/schema.mjs +357 -0
- package/scripts/site-docs.mjs +295 -0
- package/scripts/site-docs.test.mjs +181 -0
- package/scripts/vendor-lock.mjs +58 -0
- package/scripts/vendor-lock.test.mjs +69 -0
- package/src/README.md +38 -0
- package/src/app/App.tsx +448 -0
- package/src/app/BranchPicker.test.ts +46 -0
- package/src/app/BranchPicker.tsx +153 -0
- package/src/app/Breadcrumbs.test.ts +38 -0
- package/src/app/Breadcrumbs.tsx +223 -0
- package/src/app/BuildStamp.tsx +146 -0
- package/src/app/CommandPalette.tsx +292 -0
- package/src/app/HashScroll.tsx +45 -0
- package/src/app/Sidebar.tsx +1742 -0
- package/src/app/TopBar.tsx +393 -0
- package/src/app/density.tsx +64 -0
- package/src/app/forge-access.test.ts +27 -0
- package/src/app/forge-access.tsx +80 -0
- package/src/app/panels.tsx +141 -0
- package/src/app/pins.tsx +242 -0
- package/src/app/query-client.ts +24 -0
- package/src/app/responsive.ts +55 -0
- package/src/app/shortcuts.test.ts +39 -0
- package/src/app/shortcuts.tsx +282 -0
- package/src/app/theme.tsx +51 -0
- package/src/app/title.test.ts +14 -0
- package/src/app/title.ts +30 -0
- package/src/app/toast.tsx +59 -0
- package/src/app/tree-keys.test.ts +80 -0
- package/src/app/tree-keys.ts +87 -0
- package/src/app/ui-store.ts +52 -0
- package/src/catalog-error.test.ts +105 -0
- package/src/catalog-profile.test.ts +59 -0
- package/src/catalog-profile.ts +101 -0
- package/src/catalog-stores.test.ts +431 -0
- package/src/catalog.test.ts +1215 -0
- package/src/catalog.ts +3125 -0
- package/src/chat/Cards.tsx +408 -0
- package/src/chat/ChatPanel.tsx +79 -0
- package/src/chat/ChatSettings.tsx +219 -0
- package/src/chat/Composer.tsx +99 -0
- package/src/chat/Conversation.tsx +281 -0
- package/src/chat/Header.tsx +46 -0
- package/src/chat/Message.tsx +49 -0
- package/src/chat/Notice.tsx +195 -0
- package/src/chat/Starter.tsx +67 -0
- package/src/chat/Steps.tsx +45 -0
- package/src/chat/Waiting.tsx +87 -0
- package/src/chat/flags.test.ts +59 -0
- package/src/chat/flags.ts +155 -0
- package/src/chat/linkify.test.ts +30 -0
- package/src/chat/linkify.ts +45 -0
- package/src/chat/prefs.ts +56 -0
- package/src/chat/prompt.test.ts +43 -0
- package/src/chat/prompt.ts +157 -0
- package/src/chat/store.ts +35 -0
- package/src/chat/tools.ts +58 -0
- package/src/chat/transport.ts +70 -0
- package/src/components/AdrRow.tsx +29 -0
- package/src/components/AnchorLink.tsx +67 -0
- package/src/components/ApiReference.tsx +134 -0
- package/src/components/AsyncApiReference.tsx +120 -0
- package/src/components/CatalogStamp.tsx +155 -0
- package/src/components/ChannelRows.tsx +132 -0
- package/src/components/CommandRows.tsx +139 -0
- package/src/components/DiagramSkeleton.tsx +71 -0
- package/src/components/EditorLink.tsx +85 -0
- package/src/components/FieldTree.tsx +305 -0
- package/src/components/FlowTrigger.tsx +34 -0
- package/src/components/Ident.tsx +89 -0
- package/src/components/Integrations.tsx +243 -0
- package/src/components/LifecycleDiagram.tsx +110 -0
- package/src/components/MachineDocs.tsx +42 -0
- package/src/components/Markdown.tsx +173 -0
- package/src/components/MarkdownTable.tsx +206 -0
- package/src/components/Mermaid.tsx +211 -0
- package/src/components/MethodRows.tsx +309 -0
- package/src/components/Overlay.tsx +125 -0
- package/src/components/PageHeader.tsx +189 -0
- package/src/components/RowActions.tsx +97 -0
- package/src/components/SchemaDocument.tsx +89 -0
- package/src/components/Select.tsx +126 -0
- package/src/components/ShapeRows.tsx +118 -0
- package/src/components/SourceDoc.tsx +82 -0
- package/src/components/SourcePreview.tsx +441 -0
- package/src/components/TabRow.tsx +182 -0
- package/src/components/TechIcon.tsx +34 -0
- package/src/components/Toc.tsx +132 -0
- package/src/components/WhatLinksHere.tsx +273 -0
- package/src/components/WsdlReference.tsx +84 -0
- package/src/components/ddd-icons.tsx +107 -0
- package/src/components/kind.tsx +157 -0
- package/src/components/logo.tsx +61 -0
- package/src/components/primitives.tsx +264 -0
- package/src/data.test.ts +18 -0
- package/src/data.ts +202 -0
- package/src/enrich.test.ts +1150 -0
- package/src/enrich.ts +672 -0
- package/src/er/ErCanvas.tsx +533 -0
- package/src/er/RedisSchema.tsx +74 -0
- package/src/er/RelationCard.tsx +267 -0
- package/src/er/StoreHeader.tsx +155 -0
- package/src/er/TableNode.tsx +84 -0
- package/src/er/ViewNode.tsx +83 -0
- package/src/er/layout.test.ts +115 -0
- package/src/er/layout.ts +77 -0
- package/src/er/lineage.test.ts +140 -0
- package/src/er/lineage.ts +107 -0
- package/src/er/markers.tsx +79 -0
- package/src/er/spec.test.ts +344 -0
- package/src/er/spec.ts +426 -0
- package/src/flow/ChainList.tsx +162 -0
- package/src/flow/FlowTable.tsx +123 -0
- package/src/flow/FlowToolbar.tsx +372 -0
- package/src/flow/StepDetail.tsx +380 -0
- package/src/flow/StepRail.tsx +428 -0
- package/src/flow/answers.test.ts +50 -0
- package/src/flow/answers.ts +58 -0
- package/src/flow/chain.test.ts +383 -0
- package/src/flow/chain.ts +353 -0
- package/src/flow/chapters.test.ts +185 -0
- package/src/flow/chapters.ts +225 -0
- package/src/flow/continues.test.ts +102 -0
- package/src/flow/continues.ts +65 -0
- package/src/flow/cross-context.test.ts +97 -0
- package/src/flow/cross-context.ts +35 -0
- package/src/flow/mermaid.test.ts +22 -0
- package/src/flow/mermaid.ts +141 -0
- package/src/flow/outline.test.ts +212 -0
- package/src/flow/outline.ts +170 -0
- package/src/flow/paths.test.ts +129 -0
- package/src/flow/paths.ts +147 -0
- package/src/flow/prefs.test.ts +80 -0
- package/src/flow/prefs.ts +104 -0
- package/src/graph/DependencyGraph.tsx +283 -0
- package/src/graph/DependencyNodes.tsx +162 -0
- package/src/graph/EdgeLabel.tsx +61 -0
- package/src/graph/FocusedEventGraph.tsx +211 -0
- package/src/graph/GraphToolbar.tsx +187 -0
- package/src/graph/RoutedEdge.tsx +80 -0
- package/src/graph/dependency-layout.test.ts +360 -0
- package/src/graph/dependency-layout.ts +444 -0
- package/src/graph/elk.test.ts +70 -0
- package/src/graph/elk.ts +287 -0
- package/src/graph/nodes.tsx +97 -0
- package/src/graph/theme.ts +81 -0
- package/src/graph/useElkFlow.ts +125 -0
- package/src/index.css +1547 -0
- package/src/language/InLanguage.tsx +40 -0
- package/src/language/TermCard.tsx +132 -0
- package/src/language/cards.test.ts +114 -0
- package/src/language/cards.ts +111 -0
- package/src/lib/admonition.test.ts +49 -0
- package/src/lib/admonition.ts +48 -0
- package/src/lib/adr.test.ts +131 -0
- package/src/lib/adr.ts +68 -0
- package/src/lib/api.test.ts +122 -0
- package/src/lib/api.ts +135 -0
- package/src/lib/backlinks.test.ts +330 -0
- package/src/lib/backlinks.ts +567 -0
- package/src/lib/branch-compare.ts +16 -0
- package/src/lib/build-info.test.ts +76 -0
- package/src/lib/build-info.ts +80 -0
- package/src/lib/catalog-diff.test.ts +275 -0
- package/src/lib/catalog-diff.ts +655 -0
- package/src/lib/clipboard.ts +43 -0
- package/src/lib/comparison-memory.test.ts +40 -0
- package/src/lib/comparison-memory.ts +39 -0
- package/src/lib/context-color.ts +27 -0
- package/src/lib/context-map.test.ts +148 -0
- package/src/lib/context-map.ts +399 -0
- package/src/lib/data-model.test.ts +245 -0
- package/src/lib/data-model.ts +399 -0
- package/src/lib/data-problems.test.ts +178 -0
- package/src/lib/data-problems.ts +314 -0
- package/src/lib/derive.test.ts +251 -0
- package/src/lib/derive.ts +515 -0
- package/src/lib/editor-link.test.ts +125 -0
- package/src/lib/editor-link.ts +96 -0
- package/src/lib/editor-prefs.ts +27 -0
- package/src/lib/event-graph.test.ts +237 -0
- package/src/lib/event-graph.ts +327 -0
- package/src/lib/export-canvas.ts +37 -0
- package/src/lib/export-file.test.ts +30 -0
- package/src/lib/export-file.ts +20 -0
- package/src/lib/flow-tree.test.ts +177 -0
- package/src/lib/flow-tree.ts +160 -0
- package/src/lib/forge-refs.test.ts +50 -0
- package/src/lib/forge-refs.ts +60 -0
- package/src/lib/format.test.ts +35 -0
- package/src/lib/format.ts +64 -0
- package/src/lib/github-catalog.test.ts +301 -0
- package/src/lib/github-catalog.ts +610 -0
- package/src/lib/integrations.test.ts +119 -0
- package/src/lib/integrations.ts +133 -0
- package/src/lib/kinds.test.ts +91 -0
- package/src/lib/kinds.ts +204 -0
- package/src/lib/lifecycle.test.ts +93 -0
- package/src/lib/lifecycle.ts +165 -0
- package/src/lib/local-api.ts +194 -0
- package/src/lib/motion-features.ts +11 -0
- package/src/lib/motion.test.ts +120 -0
- package/src/lib/motion.tsx +269 -0
- package/src/lib/palette-recent.test.ts +80 -0
- package/src/lib/palette-recent.ts +90 -0
- package/src/lib/palette.test.ts +365 -0
- package/src/lib/palette.ts +593 -0
- package/src/lib/pins.test.ts +139 -0
- package/src/lib/pins.ts +130 -0
- package/src/lib/problems.test.ts +112 -0
- package/src/lib/project-preview.ts +5 -0
- package/src/lib/proto-problems.test.ts +121 -0
- package/src/lib/proto-problems.ts +65 -0
- package/src/lib/queries.test.ts +113 -0
- package/src/lib/queries.ts +131 -0
- package/src/lib/registry.test.ts +219 -0
- package/src/lib/registry.ts +208 -0
- package/src/lib/scenarios.ts +547 -0
- package/src/lib/setup-info.test.ts +199 -0
- package/src/lib/setup-info.ts +415 -0
- package/src/lib/shape.test.ts +289 -0
- package/src/lib/shape.ts +454 -0
- package/src/lib/sidebar-prefs.test.ts +32 -0
- package/src/lib/sidebar-prefs.ts +75 -0
- package/src/lib/source-code.test.ts +159 -0
- package/src/lib/source-code.ts +286 -0
- package/src/lib/source-doc.test.ts +131 -0
- package/src/lib/source-doc.ts +103 -0
- package/src/lib/source-highlight.test.ts +29 -0
- package/src/lib/source-highlight.ts +24 -0
- package/src/lib/source-link.test.ts +153 -0
- package/src/lib/source-link.ts +201 -0
- package/src/lib/spec-files.test.ts +24 -0
- package/src/lib/spec-files.ts +23 -0
- package/src/lib/table-directive.test.ts +139 -0
- package/src/lib/table-directive.ts +106 -0
- package/src/lib/tech.test.ts +120 -0
- package/src/lib/tech.ts +421 -0
- package/src/lib/terms.test.ts +67 -0
- package/src/lib/terms.ts +179 -0
- package/src/lib/wire-problems.test.ts +263 -0
- package/src/lib/wire-problems.ts +281 -0
- package/src/likec4/C4View.tsx +55 -0
- package/src/likec4/CanvasBridge.tsx +187 -0
- package/src/likec4/FlowView.tsx +235 -0
- package/src/likec4/InteractiveView.tsx +144 -0
- package/src/likec4/canvas-viewport.test.ts +149 -0
- package/src/likec4/canvas-viewport.ts +135 -0
- package/src/likec4/flow-edges.test.ts +51 -0
- package/src/likec4/flow-edges.ts +89 -0
- package/src/likec4/frame-theme.test.ts +76 -0
- package/src/likec4/frame-theme.ts +101 -0
- package/src/likec4/highlight-css.test.ts +49 -0
- package/src/likec4/highlight-css.ts +52 -0
- package/src/likec4/ids.test.ts +151 -0
- package/src/likec4/ids.ts +115 -0
- package/src/likec4/levels.tsx +70 -0
- package/src/likec4/mapping.test.ts +66 -0
- package/src/likec4/mapping.ts +54 -0
- package/src/likec4/reserved.json +141 -0
- package/src/likec4/view-index.ts +78 -0
- package/src/main.tsx +13 -0
- package/src/map/ContextMapGraph.tsx +274 -0
- package/src/map/ContextNode.tsx +70 -0
- package/src/map/FloatingEdge.tsx +86 -0
- package/src/merge.test.ts +1038 -0
- package/src/merge.ts +1004 -0
- package/src/pages/AdrDetail.tsx +242 -0
- package/src/pages/AdrIndex.tsx +114 -0
- package/src/pages/AggregatePage.tsx +727 -0
- package/src/pages/BlockPage.tsx +478 -0
- package/src/pages/CatalogFailure.tsx +111 -0
- package/src/pages/Changes.tsx +313 -0
- package/src/pages/ContextMap.tsx +534 -0
- package/src/pages/ContextPage.tsx +346 -0
- package/src/pages/EnumPage.tsx +282 -0
- package/src/pages/EventPage.tsx +686 -0
- package/src/pages/ExternalPage.tsx +204 -0
- package/src/pages/FlowDetail.tsx +663 -0
- package/src/pages/FlowIndex.tsx +303 -0
- package/src/pages/GraphPage.tsx +217 -0
- package/src/pages/Language.tsx +257 -0
- package/src/pages/ModulePage.tsx +366 -0
- package/src/pages/NotFound.tsx +54 -0
- package/src/pages/Overview.tsx +344 -0
- package/src/pages/Problems.tsx +360 -0
- package/src/pages/RegistryIndex.tsx +118 -0
- package/src/pages/ServicePage.tsx +746 -0
- package/src/pages/Settings.tsx +975 -0
- package/src/pages/StorePage.tsx +114 -0
- package/src/peek/PeekCard.test.ts +35 -0
- package/src/peek/PeekCard.tsx +118 -0
- package/src/peek/PeekLayer.tsx +147 -0
- package/src/peek/model.test.ts +156 -0
- package/src/peek/model.ts +253 -0
- package/src/routes.test.ts +222 -0
- package/src/routes.ts +449 -0
- package/src/selection/DetailPanel.tsx +1407 -0
- package/src/selection/hash.test.ts +73 -0
- package/src/selection/hash.ts +58 -0
- package/src/selection/model.test.ts +199 -0
- package/src/selection/model.ts +473 -0
- package/src/selection/pages.test.ts +115 -0
- package/src/selection/pages.ts +268 -0
- package/src/selection/store.test.ts +62 -0
- package/src/selection/store.ts +46 -0
- package/src/selection/sync.tsx +99 -0
- package/src/table/ColumnsMenu.tsx +72 -0
- package/src/table/DataTable.tsx +780 -0
- package/src/table/Facets.tsx +54 -0
- package/src/table/GroupMenu.tsx +69 -0
- package/src/table/Toolbar.tsx +190 -0
- package/src/table/cells.tsx +117 -0
- package/src/table/compare.test.ts +117 -0
- package/src/table/compare.ts +196 -0
- package/src/table/export.test.ts +88 -0
- package/src/table/export.ts +66 -0
- package/src/table/facet-groups.test.ts +74 -0
- package/src/table/facet-groups.ts +56 -0
- package/src/table/grouping.test.ts +84 -0
- package/src/table/grouping.ts +82 -0
- package/src/table/infer.test.ts +57 -0
- package/src/table/infer.ts +50 -0
- package/src/table/persist.test.ts +76 -0
- package/src/table/persist.ts +112 -0
- package/src/table/sort-url.test.ts +75 -0
- package/src/table/sort-url.ts +52 -0
- package/src/table/types.ts +80 -0
- package/src/table/useTableState.ts +220 -0
- package/src/test-catalog.ts +7 -0
- package/src/testing/estate/data__catalog.json +2847 -0
- package/src/testing/estate/data__flows.json +1724 -0
- package/src/testing/estate/examples__auth__portolan__api.json +212 -0
- package/src/testing/estate/examples__auth__portolan__domain.json +1204 -0
- package/src/testing/estate/examples__auth__portolan__glossary.json +226 -0
- package/src/testing/estate/examples__auth__portolan__observed.json +757 -0
- package/src/testing/estate/examples__auth__portolan__stores.json +195 -0
- package/src/testing/estate/examples__shop__cart__portolan__api.json +234 -0
- package/src/testing/estate/examples__shop__cart__portolan__commands.json +86 -0
- package/src/testing/estate/examples__shop__cart__portolan__domain.json +966 -0
- package/src/testing/estate/examples__shop__cart__portolan__observed.json +498 -0
- package/src/testing/estate/examples__shop__cart__portolan__stores.json +208 -0
- package/src/testing/estate/examples__shop__oms__portolan__glossary.json +98 -0
- package/src/testing/estate/examples__shop__oms__portolan__proto.json +186 -0
- package/src/testing/estate.ts +49 -0
- package/src/trail/Trail.tsx +81 -0
- package/src/trail/model.test.ts +157 -0
- package/src/trail/model.ts +189 -0
- package/src/trail/record.tsx +32 -0
- package/src/trail/store.test.ts +66 -0
- package/src/trail/store.ts +102 -0
- package/tsconfig.json +35 -0
- package/vite.config.ts +171 -0
|
@@ -0,0 +1,473 @@
|
|
|
1
|
+
package main
|
|
2
|
+
|
|
3
|
+
import (
|
|
4
|
+
"encoding/json"
|
|
5
|
+
"fmt"
|
|
6
|
+
"path"
|
|
7
|
+
"sort"
|
|
8
|
+
"strings"
|
|
9
|
+
|
|
10
|
+
"github.com/shortlink-org/portolan/catalog"
|
|
11
|
+
"github.com/shortlink-org/portolan/plugin"
|
|
12
|
+
"gopkg.in/yaml.v3"
|
|
13
|
+
)
|
|
14
|
+
|
|
15
|
+
type Options struct {
|
|
16
|
+
Domain string `json:"domain,omitempty"`
|
|
17
|
+
DomainTitle string `json:"domainTitle,omitempty"`
|
|
18
|
+
Owner string `json:"owner,omitempty"`
|
|
19
|
+
Lifecycle string `json:"lifecycle,omitempty"`
|
|
20
|
+
SourceBaseURL string `json:"sourceBaseUrl,omitempty"`
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
type entity struct {
|
|
24
|
+
APIVersion string `yaml:"apiVersion"`
|
|
25
|
+
Kind string `yaml:"kind"`
|
|
26
|
+
Metadata metadata `yaml:"metadata"`
|
|
27
|
+
Spec map[string]any `yaml:"spec"`
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
type metadata struct {
|
|
31
|
+
Name string `yaml:"name"`
|
|
32
|
+
Title string `yaml:"title,omitempty"`
|
|
33
|
+
Description string `yaml:"description,omitempty"`
|
|
34
|
+
Annotations map[string]string `yaml:"annotations,omitempty"`
|
|
35
|
+
Tags []string `yaml:"tags,omitempty"`
|
|
36
|
+
Links []link `yaml:"links,omitempty"`
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
// link is one of Backstage's entity links, the card on the entity page
|
|
40
|
+
// that takes a reader somewhere. `type` is Backstage's own free-text
|
|
41
|
+
// category; every link here is a command.
|
|
42
|
+
type link struct {
|
|
43
|
+
URL string `yaml:"url"`
|
|
44
|
+
Title string `yaml:"title,omitempty"`
|
|
45
|
+
Type string `yaml:"type,omitempty"`
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
func render(req plugin.Request, opts Options) (plugin.Response, error) {
|
|
49
|
+
if opts.Domain == "" {
|
|
50
|
+
opts.Domain = "architecture"
|
|
51
|
+
}
|
|
52
|
+
if opts.DomainTitle == "" {
|
|
53
|
+
opts.DomainTitle = "Architecture"
|
|
54
|
+
}
|
|
55
|
+
if opts.Owner == "" {
|
|
56
|
+
opts.Owner = "architecture"
|
|
57
|
+
}
|
|
58
|
+
if opts.Lifecycle == "" {
|
|
59
|
+
opts.Lifecycle = "production"
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
domain := entityFor("Domain", opts.Domain, opts.DomainTitle, "Architecture catalog exported by Portolan", "portolan.domain")
|
|
63
|
+
domain.Spec = map[string]any{"owner": opts.Owner}
|
|
64
|
+
entities := []entity{domain}
|
|
65
|
+
|
|
66
|
+
contexts := append([]catalog.BoundedContext(nil), req.Catalog.Contexts...)
|
|
67
|
+
sort.Slice(contexts, func(i, j int) bool { return contexts[i].ID < contexts[j].ID })
|
|
68
|
+
apiName := map[string]string{}
|
|
69
|
+
serviceName := map[string]string{}
|
|
70
|
+
for i := range contexts {
|
|
71
|
+
for j := range contexts[i].Services {
|
|
72
|
+
svc := &contexts[i].Services[j]
|
|
73
|
+
serviceName[svc.ID] = nameOf(svc.ID)
|
|
74
|
+
for k := range svc.Provides {
|
|
75
|
+
apiName[svc.Provides[k].ID] = nameOf(svc.Provides[k].ID)
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
for i := range req.Catalog.Externals {
|
|
80
|
+
serviceName[req.Catalog.Externals[i].ID] = nameOf(req.Catalog.Externals[i].ID)
|
|
81
|
+
for j := range req.Catalog.Externals[i].Provides {
|
|
82
|
+
apiName[req.Catalog.Externals[i].Provides[j].ID] = nameOf(req.Catalog.Externals[i].Provides[j].ID)
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
externals := append([]catalog.External(nil), req.Catalog.Externals...)
|
|
87
|
+
sort.Slice(externals, func(i, j int) bool { return externals[i].ID < externals[j].ID })
|
|
88
|
+
for i := range externals {
|
|
89
|
+
ext := &externals[i]
|
|
90
|
+
component := entityFor("Component", ext.ID, ext.Name, ext.Summary, ext.ID)
|
|
91
|
+
provides := make([]string, 0, len(ext.Provides))
|
|
92
|
+
for j := range ext.Provides {
|
|
93
|
+
provides = append(provides, "api:default/"+nameOf(ext.Provides[j].ID))
|
|
94
|
+
}
|
|
95
|
+
component.Spec = compact(map[string]any{
|
|
96
|
+
"type": "external-service", "lifecycle": opts.Lifecycle,
|
|
97
|
+
"owner": opts.Owner, "providesApis": sortedUnique(provides),
|
|
98
|
+
})
|
|
99
|
+
entities = append(entities, component)
|
|
100
|
+
for j := range ext.Provides {
|
|
101
|
+
api := entityFor("API", ext.Provides[j].ID, ext.Provides[j].ID, "Interface provided by "+ext.Name, ext.Provides[j].ID)
|
|
102
|
+
definition, err := json.MarshalIndent(map[string]any{"id": ext.Provides[j].ID, "methods": ext.Provides[j].Methods, "messages": ext.Provides[j].Messages}, "", " ")
|
|
103
|
+
if err != nil {
|
|
104
|
+
return plugin.Response{}, err
|
|
105
|
+
}
|
|
106
|
+
api.Spec = map[string]any{"type": "portolan", "lifecycle": opts.Lifecycle, "owner": opts.Owner, "definition": string(definition)}
|
|
107
|
+
entities = append(entities, api)
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
for i := range contexts {
|
|
112
|
+
ctx := &contexts[i]
|
|
113
|
+
system := entityFor("System", ctx.ID, ctx.Name, ctx.Summary, ctx.ID)
|
|
114
|
+
system.Spec = map[string]any{"owner": opts.Owner, "domain": nameOf(opts.Domain)}
|
|
115
|
+
entities = append(entities, system)
|
|
116
|
+
|
|
117
|
+
services := append([]catalog.Service(nil), ctx.Services...)
|
|
118
|
+
sort.Slice(services, func(i, j int) bool { return services[i].ID < services[j].ID })
|
|
119
|
+
for j := range services {
|
|
120
|
+
svc := &services[j]
|
|
121
|
+
owner := ownerOf(svc, opts.Owner)
|
|
122
|
+
component := entityFor("Component", svc.ID, svc.Name, firstLine(svc.Readme), svc.ID)
|
|
123
|
+
component.Metadata.Annotations = annotations(opts.SourceBaseURL, svc.ID, svc.Path, svc.Repo, true)
|
|
124
|
+
component.Metadata.Tags = backstageTags(svc.Technologies)
|
|
125
|
+
commands(&component.Metadata, svc, opts.SourceBaseURL)
|
|
126
|
+
depends := []string{}
|
|
127
|
+
consumes := []string{}
|
|
128
|
+
for _, call := range svc.Consumes {
|
|
129
|
+
if peer := serviceName[call.Peer]; peer != "" {
|
|
130
|
+
depends = append(depends, "component:default/"+peer)
|
|
131
|
+
}
|
|
132
|
+
if api := apiName[interfaceOf(call.ID)]; api != "" {
|
|
133
|
+
consumes = append(consumes, "api:default/"+api)
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
for _, store := range svc.Stores {
|
|
137
|
+
depends = append(depends, "resource:default/"+nameOf(store))
|
|
138
|
+
}
|
|
139
|
+
for _, module := range svc.Modules {
|
|
140
|
+
depends = append(depends, "resource:default/"+nameOf(module))
|
|
141
|
+
}
|
|
142
|
+
provides := make([]string, 0, len(svc.Provides))
|
|
143
|
+
for _, provided := range svc.Provides {
|
|
144
|
+
provides = append(provides, "api:default/"+nameOf(provided.ID))
|
|
145
|
+
}
|
|
146
|
+
component.Spec = compact(map[string]any{
|
|
147
|
+
"type": componentType(svc.Kind), "lifecycle": opts.Lifecycle, "owner": owner,
|
|
148
|
+
"system": nameOf(ctx.ID), "dependsOn": sortedUnique(depends),
|
|
149
|
+
"providesApis": sortedUnique(provides), "consumesApis": sortedUnique(consumes),
|
|
150
|
+
})
|
|
151
|
+
entities = append(entities, component)
|
|
152
|
+
for k := range svc.Provides {
|
|
153
|
+
api, err := apiEntity(req, &svc.Provides[k], svc, ctx, opts)
|
|
154
|
+
if err != nil {
|
|
155
|
+
return plugin.Response{}, err
|
|
156
|
+
}
|
|
157
|
+
entities = append(entities, api)
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
stores := append([]catalog.Store(nil), req.Catalog.Stores...)
|
|
163
|
+
sort.Slice(stores, func(i, j int) bool { return stores[i].ID < stores[j].ID })
|
|
164
|
+
for i := range stores {
|
|
165
|
+
store := &stores[i]
|
|
166
|
+
resource := entityFor("Resource", store.ID, store.Name, "State owned by "+store.Owner, store.ID)
|
|
167
|
+
resource.Metadata.Annotations = annotations(opts.SourceBaseURL, store.ID, store.Source, repoOf(req.Catalog, store.Owner), sourceIsDirectory(store.Source))
|
|
168
|
+
resource.Spec = compact(map[string]any{"type": string(store.Kind), "owner": ownerForID(req.Catalog, store.Owner, opts.Owner), "system": systemFor(req.Catalog, store.Owner)})
|
|
169
|
+
entities = append(entities, resource)
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
modules := append([]catalog.ProtoModule(nil), req.Catalog.Modules...)
|
|
173
|
+
sort.Slice(modules, func(i, j int) bool { return modules[i].ID < modules[j].ID })
|
|
174
|
+
for i := range modules {
|
|
175
|
+
module := &modules[i]
|
|
176
|
+
resource := entityFor("Resource", module.ID, module.Name, "Schema module "+module.ID, module.ID)
|
|
177
|
+
resource.Metadata.Annotations = annotations(opts.SourceBaseURL, module.ID, module.Source, repoOf(req.Catalog, module.Owner), sourceIsDirectory(module.Source))
|
|
178
|
+
resource.Spec = compact(map[string]any{"type": "schema-module", "owner": ownerForID(req.Catalog, module.Owner, opts.Owner), "system": systemFor(req.Catalog, module.Owner)})
|
|
179
|
+
entities = append(entities, resource)
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
documents := make([]string, 0, len(entities))
|
|
183
|
+
for i := range entities {
|
|
184
|
+
if err := validateEntity(entities[i], entities); err != nil {
|
|
185
|
+
return plugin.Response{}, err
|
|
186
|
+
}
|
|
187
|
+
raw, err := yaml.Marshal(entities[i])
|
|
188
|
+
if err != nil {
|
|
189
|
+
return plugin.Response{}, fmt.Errorf("backstage entity %s: %w", entities[i].Metadata.Name, err)
|
|
190
|
+
}
|
|
191
|
+
documents = append(documents, strings.TrimSpace(string(raw)))
|
|
192
|
+
}
|
|
193
|
+
return plugin.Response{Files: []plugin.File{{Name: "catalog-info.yaml", Contents: strings.Join(documents, "\n---\n") + "\n"}}}, nil
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
func componentType(kind catalog.ComponentKind) string {
|
|
197
|
+
switch kind {
|
|
198
|
+
case catalog.ComponentKindWebapp:
|
|
199
|
+
return "website"
|
|
200
|
+
case catalog.ComponentKindLibrary:
|
|
201
|
+
return "library"
|
|
202
|
+
case catalog.ComponentKindCLI:
|
|
203
|
+
return "tool"
|
|
204
|
+
case catalog.ComponentKindDataPipeline:
|
|
205
|
+
return "data-pipeline"
|
|
206
|
+
case catalog.ComponentKindApplication:
|
|
207
|
+
return "application"
|
|
208
|
+
case catalog.ComponentKindWorker:
|
|
209
|
+
return "worker"
|
|
210
|
+
case catalog.ComponentKindJob:
|
|
211
|
+
return "job"
|
|
212
|
+
case catalog.ComponentKindFunction:
|
|
213
|
+
return "function"
|
|
214
|
+
default:
|
|
215
|
+
return "service"
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
func backstageTags(technologies []string) []string {
|
|
220
|
+
tags := make([]string, 0, len(technologies))
|
|
221
|
+
for _, technology := range technologies {
|
|
222
|
+
if tag := nameOf(technology); tag != "" {
|
|
223
|
+
tags = append(tags, tag)
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
return sortedUnique(tags)
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
func apiEntity(req plugin.Request, rpc *catalog.RpcService, svc *catalog.Service, ctx *catalog.BoundedContext, opts Options) (entity, error) {
|
|
230
|
+
definition, err := json.MarshalIndent(map[string]any{"id": rpc.ID, "module": rpc.Module, "methods": rpc.Methods, "messages": rpc.Messages}, "", " ")
|
|
231
|
+
if err != nil {
|
|
232
|
+
return entity{}, err
|
|
233
|
+
}
|
|
234
|
+
api := entityFor("API", rpc.ID, rpc.ID, "Interface provided by "+svc.Name, rpc.ID)
|
|
235
|
+
api.Metadata.Annotations = annotations(opts.SourceBaseURL, rpc.ID, sourceWithin(svc.Path, rpc.Source), svc.Repo, false)
|
|
236
|
+
// The definition is Portolan's normalized contract, not the original
|
|
237
|
+
// OpenAPI/proto document. Calling it openapi or grpc would make Backstage
|
|
238
|
+
// feed valid JSON to the wrong renderer.
|
|
239
|
+
api.Spec = compact(map[string]any{"type": "portolan", "lifecycle": opts.Lifecycle, "owner": ownerOf(svc, opts.Owner), "system": nameOf(ctx.ID), "definition": string(definition)})
|
|
240
|
+
return api, nil
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
func entityFor(kind, id, title, description, portolanID string) entity {
|
|
244
|
+
return entity{APIVersion: "backstage.io/v1alpha1", Kind: kind, Metadata: metadata{Name: nameOf(id), Title: title, Description: strings.TrimSpace(description), Annotations: map[string]string{"portolan.io/id": portolanID}}, Spec: map[string]any{}}
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
func annotations(sourceBase, id, source, repo string, directory bool) map[string]string {
|
|
248
|
+
out := map[string]string{"portolan.io/id": id}
|
|
249
|
+
if url := sourceURL(sourceBase, source, repo, directory, false); url != "" {
|
|
250
|
+
out["backstage.io/source-location"] = "url:" + url
|
|
251
|
+
}
|
|
252
|
+
return out
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
// sourceURL is where `source` is on the forge, when the source base names
|
|
256
|
+
// the same repository - or "" when the catalog cannot say. A `:line` suffix
|
|
257
|
+
// is dropped, or kept as the `#L` anchor both forges read, when asked.
|
|
258
|
+
func sourceURL(sourceBase, source, repo string, directory, keepLine bool) string {
|
|
259
|
+
if sourceBase == "" || !sameRepo(repo, sourceBaseRepo(sourceBase)) {
|
|
260
|
+
return ""
|
|
261
|
+
}
|
|
262
|
+
path := strings.TrimPrefix(strings.TrimSpace(source), "/")
|
|
263
|
+
line := ""
|
|
264
|
+
if at := strings.LastIndex(path, ":"); at > 0 {
|
|
265
|
+
if keepLine {
|
|
266
|
+
line = "#L" + path[at+1:]
|
|
267
|
+
}
|
|
268
|
+
path = path[:at]
|
|
269
|
+
}
|
|
270
|
+
if path == "" {
|
|
271
|
+
return ""
|
|
272
|
+
}
|
|
273
|
+
base := strings.TrimSuffix(sourceBase, "/")
|
|
274
|
+
if directory {
|
|
275
|
+
base = strings.Replace(base, "/-/blob/", "/-/tree/", 1)
|
|
276
|
+
base = strings.Replace(base, "/blob/", "/tree/", 1)
|
|
277
|
+
}
|
|
278
|
+
return base + "/" + path + line
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
// commands puts what a developer types onto the component, twice, because
|
|
282
|
+
// Backstage has no field for it. The annotation is the list itself, one
|
|
283
|
+
// command a line with its description, for anything that reads the entity;
|
|
284
|
+
// the links are the same commands as the Links card draws them, each
|
|
285
|
+
// leading to the line of the runner file it was read from, for the reader
|
|
286
|
+
// on the entity page. Links need a URL, so they exist only when the source
|
|
287
|
+
// base says where the repository is.
|
|
288
|
+
func commands(meta *metadata, svc *catalog.Service, sourceBase string) {
|
|
289
|
+
if len(svc.Commands) == 0 {
|
|
290
|
+
return
|
|
291
|
+
}
|
|
292
|
+
lines := make([]string, 0, len(svc.Commands))
|
|
293
|
+
for _, cmd := range svc.Commands {
|
|
294
|
+
line := cmd.Run
|
|
295
|
+
if cmd.Doc != "" {
|
|
296
|
+
line += " — " + cmd.Doc
|
|
297
|
+
}
|
|
298
|
+
lines = append(lines, line)
|
|
299
|
+
if url := sourceURL(sourceBase, cmd.Source, svc.Repo, false, true); url != "" {
|
|
300
|
+
meta.Links = append(meta.Links, link{URL: url, Title: line, Type: "command"})
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
meta.Annotations["portolan.io/commands"] = strings.Join(lines, "\n")
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
func sourceBaseRepo(base string) string {
|
|
307
|
+
for _, marker := range []string{"/-/blob/", "/-/tree/", "/blob/", "/tree/"} {
|
|
308
|
+
if at := strings.Index(base, marker); at >= 0 {
|
|
309
|
+
return base[:at]
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
return base
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
func nameOf(value string) string {
|
|
316
|
+
var b strings.Builder
|
|
317
|
+
dash := false
|
|
318
|
+
for _, r := range strings.ToLower(value) {
|
|
319
|
+
if r >= 'a' && r <= 'z' || r >= '0' && r <= '9' {
|
|
320
|
+
b.WriteRune(r)
|
|
321
|
+
dash = false
|
|
322
|
+
} else if b.Len() > 0 && !dash {
|
|
323
|
+
b.WriteByte('-')
|
|
324
|
+
dash = true
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
name := strings.Trim(b.String(), "-")
|
|
328
|
+
if name == "" {
|
|
329
|
+
return "portolan-entity"
|
|
330
|
+
}
|
|
331
|
+
if len(name) > 63 {
|
|
332
|
+
name = strings.TrimRight(name[:63], "-")
|
|
333
|
+
}
|
|
334
|
+
return name
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
func sourceWithin(root, source string) string {
|
|
338
|
+
root = strings.Trim(strings.TrimSpace(root), "/")
|
|
339
|
+
source = strings.TrimPrefix(strings.TrimSpace(source), "/")
|
|
340
|
+
if root == "" || source == "" || source == root || strings.HasPrefix(source, root+"/") {
|
|
341
|
+
return source
|
|
342
|
+
}
|
|
343
|
+
return path.Join(root, source)
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
func sourceIsDirectory(source string) bool {
|
|
347
|
+
source = strings.TrimSuffix(strings.TrimSpace(source), "/")
|
|
348
|
+
if at := strings.LastIndex(source, ":"); at > 0 {
|
|
349
|
+
source = source[:at]
|
|
350
|
+
}
|
|
351
|
+
return path.Ext(source) == ""
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
func validateEntity(current entity, all []entity) error {
|
|
355
|
+
seen := map[string]bool{}
|
|
356
|
+
for _, candidate := range all {
|
|
357
|
+
key := strings.ToLower(candidate.Kind) + ":default/" + candidate.Metadata.Name
|
|
358
|
+
if seen[key] {
|
|
359
|
+
return fmt.Errorf("duplicate Backstage entity %s", key)
|
|
360
|
+
}
|
|
361
|
+
seen[key] = true
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
check := func(field string, refs []string) error {
|
|
365
|
+
for _, ref := range refs {
|
|
366
|
+
if !seen[strings.ToLower(ref)] {
|
|
367
|
+
return fmt.Errorf("backstage entity %s/%s has unresolved %s reference %q", current.Kind, current.Metadata.Name, field, ref)
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
return nil
|
|
371
|
+
}
|
|
372
|
+
for _, field := range []string{"dependsOn", "providesApis", "consumesApis"} {
|
|
373
|
+
if refs, ok := current.Spec[field].([]string); ok {
|
|
374
|
+
if err := check(field, refs); err != nil {
|
|
375
|
+
return err
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
if value, ok := current.Spec["system"].(string); ok && value != "" {
|
|
380
|
+
if err := check("system", []string{"system:default/" + value}); err != nil {
|
|
381
|
+
return err
|
|
382
|
+
}
|
|
383
|
+
}
|
|
384
|
+
if value, ok := current.Spec["domain"].(string); ok && value != "" {
|
|
385
|
+
if err := check("domain", []string{"domain:default/" + value}); err != nil {
|
|
386
|
+
return err
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
return nil
|
|
390
|
+
}
|
|
391
|
+
|
|
392
|
+
func ownerOf(service *catalog.Service, fallback string) string {
|
|
393
|
+
if len(service.Owners) == 0 {
|
|
394
|
+
return fallback
|
|
395
|
+
}
|
|
396
|
+
return strings.TrimPrefix(service.Owners[0], "@")
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
func ownerForID(cat catalog.Catalog, id, fallback string) string {
|
|
400
|
+
for i := range cat.Contexts {
|
|
401
|
+
for j := range cat.Contexts[i].Services {
|
|
402
|
+
if cat.Contexts[i].Services[j].ID == id {
|
|
403
|
+
return ownerOf(&cat.Contexts[i].Services[j], fallback)
|
|
404
|
+
}
|
|
405
|
+
}
|
|
406
|
+
}
|
|
407
|
+
return fallback
|
|
408
|
+
}
|
|
409
|
+
func systemFor(cat catalog.Catalog, service string) string {
|
|
410
|
+
for i := range cat.Contexts {
|
|
411
|
+
for j := range cat.Contexts[i].Services {
|
|
412
|
+
if cat.Contexts[i].Services[j].ID == service {
|
|
413
|
+
return nameOf(cat.Contexts[i].ID)
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
return ""
|
|
418
|
+
}
|
|
419
|
+
func repoOf(cat catalog.Catalog, service string) string {
|
|
420
|
+
for i := range cat.Contexts {
|
|
421
|
+
for j := range cat.Contexts[i].Services {
|
|
422
|
+
if cat.Contexts[i].Services[j].ID == service {
|
|
423
|
+
return cat.Contexts[i].Services[j].Repo
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
return ""
|
|
428
|
+
}
|
|
429
|
+
func interfaceOf(call string) string {
|
|
430
|
+
if at := strings.LastIndex(call, "/"); at > 0 {
|
|
431
|
+
return call[:at]
|
|
432
|
+
}
|
|
433
|
+
return call
|
|
434
|
+
}
|
|
435
|
+
func sameRepo(a, b string) bool {
|
|
436
|
+
clean := func(v string) string {
|
|
437
|
+
return strings.ToLower(strings.TrimSuffix(strings.TrimSuffix(strings.TrimPrefix(strings.TrimPrefix(v, "https://"), "http://"), ".git"), "/"))
|
|
438
|
+
}
|
|
439
|
+
return a == "" || clean(a) == clean(b)
|
|
440
|
+
}
|
|
441
|
+
func firstLine(value string) string {
|
|
442
|
+
if at := strings.Index(value, "\n"); at >= 0 {
|
|
443
|
+
value = value[:at]
|
|
444
|
+
}
|
|
445
|
+
return strings.TrimSpace(strings.TrimPrefix(value, "# "))
|
|
446
|
+
}
|
|
447
|
+
func sortedUnique(values []string) []string {
|
|
448
|
+
seen := map[string]bool{}
|
|
449
|
+
out := []string{}
|
|
450
|
+
for _, value := range values {
|
|
451
|
+
if value != "" && !seen[value] {
|
|
452
|
+
seen[value] = true
|
|
453
|
+
out = append(out, value)
|
|
454
|
+
}
|
|
455
|
+
}
|
|
456
|
+
sort.Strings(out)
|
|
457
|
+
return out
|
|
458
|
+
}
|
|
459
|
+
func compact(values map[string]any) map[string]any {
|
|
460
|
+
for key, value := range values {
|
|
461
|
+
switch v := value.(type) {
|
|
462
|
+
case string:
|
|
463
|
+
if v == "" {
|
|
464
|
+
delete(values, key)
|
|
465
|
+
}
|
|
466
|
+
case []string:
|
|
467
|
+
if len(v) == 0 {
|
|
468
|
+
delete(values, key)
|
|
469
|
+
}
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
return values
|
|
473
|
+
}
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
package main
|
|
2
|
+
|
|
3
|
+
import (
|
|
4
|
+
"strings"
|
|
5
|
+
"testing"
|
|
6
|
+
|
|
7
|
+
"github.com/shortlink-org/portolan/catalog"
|
|
8
|
+
"github.com/shortlink-org/portolan/plugin"
|
|
9
|
+
"github.com/shortlink-org/portolan/plugin/schematest"
|
|
10
|
+
"gopkg.in/yaml.v3"
|
|
11
|
+
)
|
|
12
|
+
|
|
13
|
+
func TestOptionsSchema(t *testing.T) { schematest.Check(t, optionsSchema, Options{}) }
|
|
14
|
+
|
|
15
|
+
func TestRenderBackstageRelationships(t *testing.T) {
|
|
16
|
+
cat := catalog.Catalog{
|
|
17
|
+
Contexts: []catalog.BoundedContext{{
|
|
18
|
+
ID: "shop", Name: "Shop",
|
|
19
|
+
Services: []catalog.Service{{
|
|
20
|
+
ID: "shop.cart", Name: "Cart", Repo: "github.com/acme/shop", Path: "services/cart",
|
|
21
|
+
Owners: []string{"@team-cart"}, Stores: []string{"shop.cart.pg"},
|
|
22
|
+
Provides: []catalog.RpcService{{
|
|
23
|
+
ID: "shop.v1.Cart", Source: "api.yaml",
|
|
24
|
+
Methods: []catalog.RpcMethod{{Name: "Get", HTTP: &catalog.HttpRoute{Method: "GET", Path: "/cart"}}},
|
|
25
|
+
}},
|
|
26
|
+
}},
|
|
27
|
+
}},
|
|
28
|
+
Stores: []catalog.Store{{ID: "shop.cart.pg", Name: "Cart DB", Kind: catalog.StoreKindPostgres, Owner: "shop.cart"}},
|
|
29
|
+
}
|
|
30
|
+
resp, err := render(plugin.Request{Catalog: cat}, Options{SourceBaseURL: "https://github.com/acme/shop/blob/main"})
|
|
31
|
+
if err != nil {
|
|
32
|
+
t.Fatal(err)
|
|
33
|
+
}
|
|
34
|
+
parts := strings.Split(resp.Files[0].Contents, "\n---\n")
|
|
35
|
+
if len(parts) != 5 {
|
|
36
|
+
t.Fatalf("got %d entities\n%s", len(parts), resp.Files[0].Contents)
|
|
37
|
+
}
|
|
38
|
+
for _, part := range parts {
|
|
39
|
+
var value map[string]any
|
|
40
|
+
if err := yaml.Unmarshal([]byte(part), &value); err != nil {
|
|
41
|
+
t.Fatal(err)
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
if !strings.Contains(resp.Files[0].Contents, "providesApis:") || !strings.Contains(resp.Files[0].Contents, "team-cart") {
|
|
45
|
+
t.Fatal(resp.Files[0].Contents)
|
|
46
|
+
}
|
|
47
|
+
if !strings.Contains(resp.Files[0].Contents, "url:https://github.com/acme/shop/blob/main/services/cart/api.yaml") {
|
|
48
|
+
t.Fatal(resp.Files[0].Contents)
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
func TestComponentCarriesItsCommands(t *testing.T) {
|
|
53
|
+
cat := catalog.Catalog{Contexts: []catalog.BoundedContext{{
|
|
54
|
+
ID: "shop", Name: "Shop", Services: []catalog.Service{{
|
|
55
|
+
ID: "shop.pricing", Name: "Pricing", Repo: "github.com/acme/shop", Path: "services/pricing",
|
|
56
|
+
Commands: []catalog.Command{
|
|
57
|
+
{Runner: "make", Name: "gen", Run: "make gen", Doc: "Regenerate the stubs", Body: "buf generate", Source: "services/pricing/Makefile:6"},
|
|
58
|
+
{Runner: "make", Name: "test", Run: "make test", Source: "services/pricing/Makefile:15"},
|
|
59
|
+
},
|
|
60
|
+
}},
|
|
61
|
+
}}}
|
|
62
|
+
resp, err := render(plugin.Request{Catalog: cat}, Options{SourceBaseURL: "https://github.com/acme/shop/blob/main"})
|
|
63
|
+
if err != nil {
|
|
64
|
+
t.Fatal(err)
|
|
65
|
+
}
|
|
66
|
+
var component struct {
|
|
67
|
+
Metadata struct {
|
|
68
|
+
Annotations map[string]string
|
|
69
|
+
Links []struct{ URL, Title, Type string }
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
var part string
|
|
73
|
+
for _, candidate := range strings.Split(resp.Files[0].Contents, "\n---\n") {
|
|
74
|
+
if strings.Contains(candidate, "kind: Component") {
|
|
75
|
+
part = candidate
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
if err := yaml.Unmarshal([]byte(part), &component); err != nil {
|
|
79
|
+
t.Fatal(err)
|
|
80
|
+
}
|
|
81
|
+
if got := component.Metadata.Annotations["portolan.io/commands"]; got != "make gen — Regenerate the stubs\nmake test" {
|
|
82
|
+
t.Errorf("annotation = %q", got)
|
|
83
|
+
}
|
|
84
|
+
if len(component.Metadata.Links) != 2 || component.Metadata.Links[0].URL != "https://github.com/acme/shop/blob/main/services/pricing/Makefile#L6" || component.Metadata.Links[0].Title != "make gen — Regenerate the stubs" || component.Metadata.Links[0].Type != "command" {
|
|
85
|
+
t.Errorf("links = %+v", component.Metadata.Links)
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
// Without a source base there is nowhere to link to; the list still
|
|
89
|
+
// travels in the annotation.
|
|
90
|
+
resp, err = render(plugin.Request{Catalog: cat}, Options{})
|
|
91
|
+
if err != nil {
|
|
92
|
+
t.Fatal(err)
|
|
93
|
+
}
|
|
94
|
+
if strings.Contains(resp.Files[0].Contents, "links:") || !strings.Contains(resp.Files[0].Contents, "portolan.io/commands") {
|
|
95
|
+
t.Fatal(resp.Files[0].Contents)
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
func TestNameIsBackstageSafe(t *testing.T) {
|
|
100
|
+
if got := nameOf("buf.build/Acme/Very Long API"); got != "buf-build-acme-very-long-api" {
|
|
101
|
+
t.Fatalf("%q", got)
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
func TestNeutralComponentKindBecomesBackstageType(t *testing.T) {
|
|
106
|
+
cat := catalog.Catalog{Contexts: []catalog.BoundedContext{{
|
|
107
|
+
ID: "tools", Name: "Tools", Kind: catalog.GroupKindSystem, Services: []catalog.Service{{
|
|
108
|
+
ID: "tools.cli", Name: "CLI", Kind: catalog.ComponentKindCLI, Technologies: []string{"OpenTelemetry", "Go"},
|
|
109
|
+
}},
|
|
110
|
+
}}}
|
|
111
|
+
resp, err := render(plugin.Request{Catalog: cat}, Options{})
|
|
112
|
+
if err != nil {
|
|
113
|
+
t.Fatal(err)
|
|
114
|
+
}
|
|
115
|
+
if !strings.Contains(resp.Files[0].Contents, "type: tool") {
|
|
116
|
+
t.Fatal(resp.Files[0].Contents)
|
|
117
|
+
}
|
|
118
|
+
if !strings.Contains(resp.Files[0].Contents, "- go") || !strings.Contains(resp.Files[0].Contents, "- opentelemetry") {
|
|
119
|
+
t.Fatal(resp.Files[0].Contents)
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
func TestNameIsASCII(t *testing.T) {
|
|
124
|
+
if got := nameOf("Оплата.API"); got != "api" {
|
|
125
|
+
t.Fatalf("%q", got)
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
func TestSourceDirectoryDetection(t *testing.T) {
|
|
130
|
+
if !sourceIsDirectory("services/cart/repository") || sourceIsDirectory("services/cart/api.yaml:12") {
|
|
131
|
+
t.Fatal("source directory detection drifted")
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
func TestRenderRejectsDanglingBackstageReferences(t *testing.T) {
|
|
136
|
+
cat := catalog.Catalog{Contexts: []catalog.BoundedContext{{
|
|
137
|
+
ID: "shop", Name: "Shop", Services: []catalog.Service{{
|
|
138
|
+
ID: "shop.cart", Name: "Cart", Stores: []string{"missing.store"},
|
|
139
|
+
}},
|
|
140
|
+
}}}
|
|
141
|
+
_, err := render(plugin.Request{Catalog: cat}, Options{})
|
|
142
|
+
if err == nil || !strings.Contains(err.Error(), "unresolved dependsOn") {
|
|
143
|
+
t.Fatalf("expected unresolved reference, got %v", err)
|
|
144
|
+
}
|
|
145
|
+
}
|
|
Binary file
|