btburnett3/couchbasefakeit

概述

couchbasefakeit是一个专为测试和本地开发设计的Docker镜像。它在Docker容器中启动单个独立的Couchbase Server实例，并使用您定义的桶、索引和假数据对其进行初始化。假数据通过FakeIt生成。

该镜像可显著减少开发摩擦，提供快速轻松地启动预配置Couchbase服务器的方式。通过在源代码控制仓库中包含Dockerfile及相关配置文件，您可以将开发数据定义与应用程序一起版本化管理。

拉取镜像

最新版本可通过以下命令拉取：

sh
docker pull btburnett3/couchbasefakeit:latest

latest标签对应最新的Couchbase企业版及最新版本的FakeIt。

也可使用特定版本，例如enterprise-4.6.3，表示Couchbase企业版4.6.3版本。

使用couchbasefakeit

要使用couchbasefakeit，需创建自己的Dockerfile，以couchbasefakeit作为基础镜像。然后将配置文件添加到新镜像的/startup目录。您还可以覆盖环境变量以更改Couchbase Server配置。

dockerfile
FROM btburnett3/couchbasefakeit:latest

# 自定义环境变量
ENV CB_DATARAM=256 \
    CB_PASSWORD=mypassword

# 复制文件
COPY . /startup/

环境变量

可通过以下环境变量修改Couchbase Server配置：

CB_SERVICES和CB_INDEXSTORAGE的值对应Couchbase REST API的参数。

桶配置

要配置桶，只需在镜像的/startup目录中放置buckets.json文件。该文件应包含桶定义对象的数组。

json
[
  {
    "name": "sample",
    "ramQuotaMB": 100,
    "bucketType": "membase",
    "authType": "sasl",
    "saslPassword": "",
    "evictionPolicy": "fullEviction",
    "replicaNumber": 0,
    "flushEnabled": 1
  },
  {
    "name": "default",
    "ramQuotaMB": 100,
    "bucketType": "membase",
    "authType": "sasl",
    "saslPassword": "",
    "evictionPolicy": "fullEviction",
    "replicaNumber": 0,
    "flushEnabled": 1
  }
]

此文件中的属性名称和值与Couchbase REST API创建桶端点对应。

如果未在镜像中覆盖此文件，将默认创建一个名为default、RAM配额为100MB的桶。

使用FakeIt生成数据

要使用FakeIt生成数据，在/startup目录下创建以桶名命名的目录，并在该目录下创建models子目录。例如/startup/sample/models（名称区分大小写）。将FakeIt YAML模型添加到models目录。

FakeIt将在启动过程中自动使用这些模型运行。您还可以在镜像中包含输入文件（如CSV），供模型引用。

此过程在索引创建前执行，以避免索引更新影响数据插入性能。

创建视图

要创建视图，在/startup目录下创建以桶名命名的目录，并在其中放置名为views.json的文本文件。该文件应为包含一个或多个设计文档规范的JSON对象，每个属性名称为设计文档名称。

json
{
  "customers": {
    "views": {
        "CustomersByFirstName": {
            "map": "function (doc, meta) {\n  if ((doc.type === \"customer\") && doc.firstName) {\n    emit(doc.firstName, null);\n  }\n}"
        }
    }
  }
}

设计文档语法示例可参考Couchbase文档。注意views.json比Couchbase示例多一层嵌套，支持在单个文件中定义多个设计文档。

创建索引

要创建索引，在/startup目录下创建以桶名命名的目录，并在其中放置名为indexes.n1ql的文件。例如/startup/default/indexes.n1ql（名称区分大小写）。

在此文件中，可定义CREATE INDEX语句（以分号分隔）。为提高性能，建议所有索引使用WITH {"defer_build": true}，并在文件末尾使用BUILD INDEX语句。

sql
CREATE PRIMARY INDEX `#primary` ON default WITH {"defer_build": true};
CREATE INDEX `Types` ON default (`type`) WITH {"defer_build": true};
BUILD INDEX ON default (`#primary`, `Types`)

使用YAML创建索引

此外，可在/startup/<bucketname>/indexes文件夹下添加包含索引定义的YAML文件。此操作使用couchbase-index-manager创建索引。详见此处了解YAML文件格式说明。

创建全文搜索索引

要创建FTS索引，在/startup目录下创建以桶名命名的目录，并在其中创建fts子目录。在fts目录中，为每个索引添加JSON文件，文件名即为索引名。例如/startup/default/fts/my_index.json（名称区分大小写）。

在该文件中放置JSON索引定义，可从Couchbase控制台轻松导出。

要创建FTS索引别名，在同一文件夹中添加名为aliases.json的文件。该文件应为对象，每个属性为别名名称，值为索引名数组。

json
{
    "my_alias": ["my_index"],
    "my_second_alias": ["my_index_2", "my_index_3"]
}

示例

示例镜像配置可在此处查看。

本地运行示例步骤：

1. 确保本地未运行Couchbase Server以避免端口冲突
2. git clone https://github.com/brantburnett/couchbasefakeit.git
3. cd couchbasefakeit/example
4. docker-compose up -d
5. 15-30秒后，服务器可通过http://localhost:8091访问。用户名为"Administrator"，密码为"mypassword"。

关闭并清理：

1. docker-compose down

更多FakeIt模型示例详见https://github.com/bentonam/fakeit/tree/dev/test/fixtures/models%E3%80%82