Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Support HS upgrade tests

オープン
#150 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 14 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
docker, go, postgres

調査の方向性

まず cmd/dendrite-upgrade-tests と Complement の /tests インフラストラクチャを読み、次に SYNAPSE_VERSION が扱われている dockerfiles/Synapse.Dockerfile を調べます。実装前に、提案されている HS_VERSION と永続化の契約を明確にします。完了時には、サポート対象のホームサーバー向けに、文書化され再現可能なアップグレードテスト手順を含める必要があります。

索引モデルが issue の本文から書いたものです。

説明

enhancement

Dendrite has https://github.com/matrix-org/dendrite/tree/master/cmd/dendrite-upgrade-tests which will automatically pull and run different versions of dendrite with the same database and ensure db migrations work correctly. It can be run for example by doing ./dendrite-upgrade-tests --from 0.1.0 --to 0.3.1. This will:

  • Fetch semver looking tags from github (or HEAD).
  • Sort them.
  • Pull archives for each release.
  • Execute a Dockerfile with the build context set to the root directory of the release.
  • Run the lowest semver, make some users and rooms, send a few messages, tear down the server.
  • Keep the database as a docker volume.
  • Repeat with the next lowest semver up until --to.
  • Test that the last HS run has the original users/rooms/messages from all previous runs.

It looks like Synapse has some bisectability baked into the Complement Synapse image: https://github.com/matrix-org/complement/blob/76db9e5ae6c45d889000feb19f024f184c8bd6e3/dockerfiles/Synapse.Dockerfile#L14

If Complement standardised the format of this (e.g thou shalt accept the build arg HS_VERSION=$semver) then we could, in theory, make https://github.com/matrix-org/dendrite/tree/master/cmd/dendrite-upgrade-tests work for any HS (modulo working out how to do persistence, as currently Dendrite uses postgres and that assumption is baked into the upgrade testing infra: this could just be stating that the directory /data is persisted across runs and you need to just dump your DB there).

This arguably is and isn't feature creep. It is feature creep because it has nothing to do with the integration tests in /tests. It isn't feature creep because it is still ultimately testing HSes, just the upgrade paths.

Thoughts @richvdh (on the basis that you added SYNAPSE_VERSION?

主要言語
Go
スター
101
フォーク
72
平均マージ
11日 5時間
マージ済み PR(30日)
7

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

matrix-org/complement のほかの issue

matrix-org/complement の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。