Skip to content

機関管理者の適切な権限機能のテスト追加 - #61

Draft
lieunguyen-tma wants to merge 6 commits into
RCOSDP:mainfrom
lieunguyen-tma:feature/nii_grdm_202510_step2/institutional_admin_api_authorization
Draft

lieunguyen-tma wants to merge 6 commits into
RCOSDP:mainfrom
lieunguyen-tma:feature/nii_grdm_202510_step2/institutional_admin_api_authorization

Conversation

@lieunguyen-tma

Copy link
Copy Markdown
Contributor

Purpose

機関管理者の適切な権限機能に対するテストケースを追加する。

Changes

本PRの変更を「(1) 機関管理者の適切な権限テスト本体」と「(2) それをCIで実行するための共有CI基盤の修正」に分けて記載する。

(1) 機関管理者の適切な権限テスト本体(本リポジトリ内のみ/共有CIへの影響なし)

機関管理者の適切な権限機能のテスト手順を追加し、実行可能にするための変更。

  • テスト手順-管理者機能-機関管理者の適切な権限-未ログイン.ipynb を追加。主なテスト内容:未ログインユーザが統合管理者向け、機関管理者向けのページにアクセスできないことを確認。
  • テスト手順-管理者機能-機関管理者の適切な権限-機関管理者.ipynb を追加。主なテスト内容:機関管理者のアクセス制御を確認。
  • テスト手順-管理者機能-機関管理者の適切な権限-統合管理者.ipynb を追加。主なテスト内容:統合管理者のアクセス制御を確認。
  • テスト手順-管理者機能-機関管理者の適切な権限-クリーンアップ処理.ipynb を追加。主なテスト内容:テスト実行後のデータクリーンアップ処理。
  • 取りまとめ-管理者機能-機関管理者の適切な権限.ipynb を追加。CI・手動実行のエントリポイントとして上記全テストノートブックを run_notebook で順次実行する。必要なパラメータ(admin_rdm_url、統合管理者/機関管理者認証情報、user_guid、各プロバイダー名等)をすべて受け取る。
  • 結合試験-実行.ipynb:institutional_admin_authorization_enabled フラグおよび cas_rdm_url、idp_username_integrated_admin_2/idp_password_integrated_admin_2、user_guid、user_name、integrated_admin_user_name、各プロバイダー名パラメータを追加し、取りまとめ-管理者機能-機関管理者の適切な権限.ipynb の run_notebook 実行セルを追加。

(2) 機関管理者の適切な権限テストをCIで実行するための共有CI基盤の修正

(2-a) テストユーザー追加・プロバイダーデータ作成 — setup_test_data.py の修正

  • [email protected](fullname: Test User 7、is_superuser: True)を新規追加。統合管理者2としての動作確認用ユーザーのためプロジェクトは事前作成しない(skip_project: true)。
  • INSTITUTIONAL_ADMIN_AUTHORIZATION_ENABLED=true の場合のみ、以下のプロバイダー・データを作成(冪等性確保):
    • RegistrationProvider(_id: osf, name: OSF Registries)を作成し、testuser2 のプロジェクトにリンクしたレジストレーションを1件作成。
    • PreprintProvider(_id: osf, name: Open Science Framework)を作成し、testuser2 のプリプリントを1件作成。
    • CollectionProvider(_id: idtest, name: OSF Collection)および primary_collection を作成し、testuser2 のプロジェクトをコレクションに登録。
    • テストデータ用に [email protected]: <guid> をstdoutに出力。

(2-b) 新テストグループ追加・フラグ追加 — e2e-test.yml の修正

  • 全テストグループに institutional_admin_authorization_enabled フィールドを追加(既存グループはすべて false)。
  • 新テストグループ admin-institutional-admin-authorization(Display: "Admin Tests (Institutional Admin Authorization)")を追加。include_admin: true、institutional_admin_authorization_enabled: true、その他テスト(admin/metadata/login/upload/MinIO/WEKO/Mibyo DB/JupyterHub/Flowable/Wiki)はすべてスキップ設定。機関管理者の適切な権限テストのみを実行する専用グループ。
  • INSTITUTIONAL_ADMIN_AUTHORIZATION_ENABLED 環境変数を matrix.test-group.institutional_admin_authorization_enabled から解決して env: ブロックに追加。
  • テストデータ作成・マイグレーション前データ作成の両ステップにおける docker-compose exec コマンドへ -e INSTITUTIONAL_ADMIN_AUTHORIZATION_ENABLED="${INSTITUTIONAL_ADMIN_AUTHORIZATION_ENABLED}" を追加(setup_test_data.py に環境変数を渡すため)。
  • USER_GUID をsetupスクリプト出力から抽出し GITHUB_ENV にエクスポート。INSTITUTIONAL_ADMIN_AUTHORIZATION_ENABLED=true かつ USER_GUID が空の場合はエラー終了。
  • run_tests.py 呼び出し時に institutional_admin_authorization_enabled: ${{ matrix.test-group.institutional_admin_authorization_enabled == true }} を追加。
  • 機関管理者の適切な権限テスト専用パラメータを run_tests.py 呼び出しに追加(idp_username_integrated_admin_2、idp_password_integrated_admin_2)。
  • INSTITUTIONAL_ADMIN_AUTHORIZATION_ENABLED=true の場合のみ、user_guid、user_name、integrated_admin_user_name、registration_provider_name、preprint_provider_name、collection_provider_name を config に追加。

(2-c) 全テスト共通CIエントリポイントの修正 — run_tests.py の修正

  • run_institutional_admin_authorization_tests() メソッドを新規追加。institutional_admin_authorization_enabled=true の場合のみ 取りまとめ-管理者機能-機関管理者の適切な権限.ipynb を実行し、必要なパラメータ(admin_rdm_url、idp_name/username/password_integrated_admin、idp_username/password_integrated_admin_2、integrated_admin_user_name、idp_name/username/password_institutional_admin、user_guid、user_name、各プロバイダー名)を伝播する。既存のテスト実行メソッドには手を加えておらず、既存テストグループのCIフローへの影響はない。
  • 新規インスタンス変数として institutional_admin_authorization_enabled、user_guid、user_name、registration_provider_name、preprint_provider_name、collection_provider_name、idp_username_integrated_admin_2、idp_password_integrated_admin_2、integrated_admin_user_name を追加。

Note

CI の環境(IdP が FakeCAS)の場合、次の手順は実行されずに通過します。CI が成功していても、これらの手順は確認されていません。

  • /Shibboleth.sso/Status(管理画面・cas)
  • /password/recover・/password/recover/<signature>
  • /password/reset/<token>(GET・POST)・/password/reset/done
  • /account/login(POST)
  • 未ログインテストの /admin/login (GET・POST)
  • 統合管理者の /statistics/test/mail

実施による影響とクリーンアップ

試験の実施により以下の変更が行われる。クリーンアップ処理で元に戻るものと、戻らないものを以下に記載する。

  • 統合管理者の一時的な無効化(統合管理者テスト手順で Is registered のチェックを外すことで無効化される。クリーンアップ処理の手順 No.5 で Is registered にチェックを入れ、有効化する)
  • 許可するスキーマの更新(統合管理者テスト手順 No.6 で OSF Registries の許可スキーマを変更後、手順 No.7 で元の状態に戻す)
  • 全ユーザーのクォータの再計算(削除されていない全ユーザーのクォータを再計算し、データベースに保存する)
  • テストメールの送信(機関ごとに、所属する管理者宛て(統合管理者を CC)に、統計 PDF を添付したメールを実際に送信する。CI 環境では上記 Note の通りスキップされるため、実環境実施時のみ発生)
  • waffle フラグ・スイッチの追加(Management Commands の「Run」ボタン実行により、コードに定義済みで未登録の waffle フラグ・スイッチが、無効の状態で追加される)

Ticket

60922

Custom Test Configuration

  • RDM_REPOSITORY: RCOSDP/RDM-osf.io
  • RDM_BRANCH: feature/nii_grdm_202510_step2/institutional_admin_api_authorization
  • OSF_IMAGE:
  • EMBER_IMAGE:
  • CAS_IMAGE:
  • MFR_IMAGE:
  • WB_IMAGE:
  • EXCLUDE_NOTEBOOKS:

@lieunguyen-tma
lieunguyen-tma marked this pull request as draft November 4, 2026 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant