README

Keboola 高级通用存储后端驱动程序

设置AWS凭证

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
# bucket is needed for import/export tests
AWS_S3_BUCKET=
AWS_REGION=eu-central-1

构建Docker镜像

docker compose build

Xdebug

要使用xdebug运行，请使用dev-xdebug容器而不是dev

生成protobuf代码

docker compose run --rm dev composer protobuf

生成protobuf文档

文档将放置在docs文件夹中。有关更多选项，请参阅文档。

docker run --rm \
  -v $(pwd)/docs:/out \
  -v $(pwd)/proto:/protos \
  pseudomuto/protoc-gen-doc

测试

使用以下命令运行测试。

docker compose run --rm dev composer tests

要运行单独的测试，首先生成测试protobuf类

docker compose run --rm dev composer protobufTests

要禁用重试，复制phpunit-retry.xml.dist

cp phpunit-retry.xml.dist phpunit-retry.xml

调试查询

要在测试期间调试执行的查询，请设置DEBUG环境变量为1

代码质量检查

#run all bellow but not tests
docker compose run --rm dev composer check

#phplint
docker compose run --rm dev composer phplint

#phpcs
docker compose run --rm dev composer phpcs

#phpcbf
docker compose run --rm dev composer phpcbf

#phpstan
docker compose run --rm dev composer phpstan

完整的CI工作流程

此命令将运行所有检查并运行测试

docker compose run --rm dev composer ci

许可证

MIT许可证，请参阅LICENSE文件。

keboola / storage-driver-common

维护者

详细信息