データセットプロバイダーの変更

このガイドでは、開発者がデータセットプロバイダーにローカルな変更を加える方法について説明します。

概要

このガイドは Java 開発者を対象としています。

プロバイダーに加えた変更をテストできるようにするには、プロバイダーを Keycloak の実行中のインスタンスにデプロイする必要があります。プロバイダーの JAR ファイルを変更するたびに、Keycloak に再デプロイする必要があります。

前提条件

Java と Keycloak の Java API の知識が必要です。または、開発中に学習する必要があります。

推奨されるセットアップは、minikube 上の Keycloak にデータセットプロバイダーをインストールするガイドを最初に完了することです。これは、リモートデバッグ用に完全にスクリプト化され、準備されているためです。

Keycloak Wildfly またはローカルで実行中の Keycloak Quarkus インスタンスに対してプロバイダーを開発することも可能ですが、今日のこのガイドの一部ではありません。

ローカルセットアップを使用した変更の準備

IDE で Keycloak Benchmark プロジェクトを開いたら、新しい要件または変更された要件を実装するために、次の手順に従います。

  1. 必要に応じて /dataset/src のソースコードを変更します。

  2. モジュールのファイルパスから IDE でテストクラス DeploymentIT を開始します。これにより、プロバイダーがパッケージ化され、Keycloak の Quarkus インスタンスにインストールされます。

  3. https://:8080 を開いて Quarkus と対話し、リモートデバッグを使用します。

  4. リモートデバッグはポート 8787 で利用可能であり、プロバイダーの REST API をテストします。

  5. 要件が満たされるまで、ステップ 1 から繰り返します。

minikube セットアップを使用した変更の準備

IDE で Keycloak Benchmark プロジェクトを開いたら、新しい要件または変更された要件を実装するために、次の手順に従います。

  1. 必要に応じて /dataset/src のソースコードを変更します。

  2. minikube へのインストールで説明されているように task を実行して、インストールを更新します。これにより、データセットプロバイダーの JAR ファイルの新しいバージョンがビルドされ、minikube にデプロイされ、Keycloak が再起動されます。

  3. Keycloak のデバッグの手順に従って、実行中の Keycloak インスタンスに接続してプロバイダーをデバッグし、データセットの生成で概説されているようにプロバイダーの API をテストします。

  4. 要件が満たされるまで、ステップ 1 から繰り返します。