Recount the integration test files and complete the in-network port table

Closed Beginner friendly
  • Is something wrong?
#2,158 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
docker-compose, kafka
Domain
devops, documentation

Research direction

Start by running bun tests/run-tests.ts tests/integration --list to get the file count, then update the counts at README.md:678 and :702, README_zh.md:626 and :650, and README_ko.md:642 and :666. For docs/providers/README.md, add the Cassandra, Prometheus, Kafka (19092) and etcd rows to the in-network table, taking ports from database-compose.yml. Done when the grep checks in the issue return no stale counts and every host-port service has an in-network row.

Written by the indexing model from the issue text.

Description

documentation good first issue

What

README.md, README_zh.md and README_ko.md say tests/integration/ holds 24 test files. The test runner lists 72 today. The Chinese and Korean rows also name only 13 providers, where tests/integration/db/ now covers many more.

The in-network port table in docs/providers/README.md (the one for a Studio container joined to the fixture network) also lacks rows for services that database-compose.yml runs, among them Cassandra, Prometheus, Kafka and etcd.

Where

  • README.md:678

    bun run test:integration # Database provider tests (24 files)

  • README.md:702

    | Integration | tests/integration/ | 24 | 2,768 | Database providers, one test file per provider in tests/integration/db/, plus the MCP server, seed and storage layers |

  • README_zh.md:626

    bun run test:integration # 数据库 provider 测试（24 个文件）

  • README_zh.md:650

    | Integration | tests/integration/ | 24 | 2,768 | 数据库 provider：PG、MySQL、SQLite、MongoDB、Couchbase、Redis、Oracle、MSSQL、ClickHouse、Druid、Elasticsearch、OpenSearch、Trino |

  • README_ko.md:642

    bun run test:integration # Database provider 테스트 (24개 파일)

  • README_ko.md:666

    | Integration | tests/integration/ | 24 | 2,768 | Database provider: PG, MySQL, SQLite, MongoDB, Couchbase, Redis, Oracle, MSSQL, ClickHouse, Druid, Elasticsearch, OpenSearch, Trino |

  • docs/providers/README.md:527 to :544, the in-network table. It ends with:

    | Apache Spark, token server over TLS | spark-tls | 15005 |

    The host-port table above it (docs/providers/README.md:306 onward) has rows for Cassandra, Prometheus, Kafka and etcd. The in-network table has none of them. It also has no row for Db2 LUW, libSQL, Databend, InfluxDB, Oxia, Neo4j, Milvus, Qdrant, Weaviate or the S3-compatible services.

Expected

  • The file count in all six places matches bun tests/run-tests.ts tests/integration --list (72 at commit 365e53a5e).

  • The Chinese and Korean rows describe the layer the way README.md:702 does (provider tests in tests/integration/db/, plus the MCP server, seed and storage layers), not with a short list of providers.

  • The 2,768 in the Tests column is either replaced with a fresh total or removed. Do not keep a number nobody recounted.

  • The in-network table has a row for each service in the host-port table. The ports for the four named above, read from database-compose.yml:

    Provider Host inside the network Port inside the network
    Apache Cassandra cassandra 9042
    Prometheus prometheus 9090
    Apache Kafka kafka 19092
    etcd etcd 2379

    Kafka is 19092 inside the network, not 9092. The 9092 listener advertises localhost:9092, which a client in another container cannot reach:

    KAFKA_ADVERTISED_LISTENERS: "PLAINTEXT_HOST://localhost:9092,PLAINTEXT://kafka:19092"

How to fix

  1. Run bun tests/run-tests.ts tests/integration --list and count the files it prints.
  2. Put that count in README.md:678, README.md:702, README_zh.md:626, README_zh.md:650, README_ko.md:642 and README_ko.md:666.
  3. In the Chinese and Korean rows, replace the 13-provider list with a translation of the English "What it covers" cell.
  4. For the Tests column: run bun run test:integration with the fixture services up (docker compose -f database-compose.yml up -d) and use the pass, fail and skip totals the runner prints at the end. If you cannot run the full set, remove the 2,768 instead. Update the note under the table (README.md:709, "The Files column was counted on ...") so it says what was counted, when, and with which command.
  5. In docs/providers/README.md, add the four rows above to the in-network table. For each other service in the host-port table, find its service in database-compose.yml and take the port the container listens on (the right side of ports:, or the in-network listener where the service advertises one), not the host port.

How to check

bun tests/run-tests.ts tests/integration --list | grep -c 'test.ts'
grep -n '24 files\|24 个文件\|24개 파일\|2,768' README.md README_zh.md README_ko.md
grep -n '`cassandra`\|`prometheus`\|`kafka`\|`etcd`' docs/providers/README.md
bun run readme:check

The second grep should print nothing once the counts are updated.

Backlog

This is entry DOC9 in docs/BACKLOG.md. The PR that fixes it deletes that entry.

Dominant language
TypeScript
Stars
810
Forks
158
Avg merge
9h 48m
Merged PRs (30d)
627

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from libredb/libredb-studio

All issues in libredb/libredb-studio

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.