Mavenエンタープライズ・アプリケーションのテスト

This tutorial needs a review. You can open a JIRA issue, or edit it in GitHub following these contribution guidelines.

このチュートリアルでは、NetBeans IDEとMaven原型を使用した単純なエンタープライズ・アプリケーションをテストする方法を示します。このチュートリアルでは、エンティティ・クラスとセッションBeanを含むエンタープライズ・アプリケーションを作成します。ウィザードを使用してBeanクラス用の単純なテスト・クラスを作成してから、IDEでそのテストを実行します。このテスト・クラスは、GlassFish埋込みEJBコンテナのインスタンスを作成し、データベースへの接続をテストします。

チュートリアルの課題

このチュートリアルに従うには、次のソフトウェアとリソースが必要です。

ソフトウェアまたはリソース 必須バージョン

NetBeans IDE

7.4、8.0、Java EEバンドル版

Java Development Kit (JDK)

バージョン7または8

GlassFish Server Open Source Edition

4.0

GlassFish Serverのインストーラは、Java EEバンドル版をダウンロードした場合に含まれています。NetBeans IDEのインストール処理の一部としてGlassFishをインストールおよび登録できます。

前提条件

このドキュメントは、次のテクノロジについて基本的な知識またはプログラミング経験を持つ読者を想定して書かれています。

  • Javaプログラミング

  • NetBeans IDE

このチュートリアルを開始する前に、必要に応じて次のドキュメントをお読みください。

IDEでのMavenの使用

NetBeans IDEには、Mavenのサポートが完全に統合されています。Mavenフレームワークを使用するプロジェクト開発は、Antでのプロジェクト開発とほぼ同じです。ただし、Mavenによるプロジェクトのビルド方法および依存性の処理方法には、いくつかの違いがあります。次のヒントは、Mavenアプリケーションを初めて作成する場合に発生するいくつかの問題を回避するのに役立ちます。

Mavenの設定の確認

これが初めてのMavenプロジェクトである場合は、「オプション」ウィンドウでMavenの構成設定を確認します。このチュートリアルを完了するには、ローカル・システムにMavenがインストールされている必要があります。MavenはIDEにバンドルされており、IDEをインストールするとインストールされます。

  1. IDEで「オプション」ウィンドウを開きます(「ツール」→「オプション」、Macの場合は「NetBeans」→プリファレンス)。

  2. 「オプション」ウィンドウで「Java」カテゴリを選択し、「Maven」タブをクリックします。

  3. 「Mavenのホーム」が指定されていることを確認します。

IDEにバンドルされているMavenバージョンを使用することも、ローカルのMavenインストール(2.0.9以降が必要)の場所を指定することもできます。

  1. 「OK」をクリックして「オプション」ウィンドウを閉じます。

Mavenサポートは、IDEでJavaが有効になっている場合に自動的に有効になります。Java EEプラグインが有効になっていない場合は、有効にする必要があります。

Mavenリポジトリの更新

ローカルおよびリモートのMavenリポジトリは、コード補完およびプロジェクトのビルド時に使用されます。プロジェクトの開発時に、必要な任意のアーティファクトをすぐに使用できるように、Mavenリモート・リポジトリの索引を更新しておきます。「オプション」ウィンドウの「Maven」タブでは、IDEが更新を確認する頻度を構成できます。「サービス」ウィンドウから、更新の有無を即時確認でき、ローカルおよびリモートのMavenリポジトリを調べることができます。

  1. 「ウィンドウ」>「サービス」を選択し、「サービス」ウィンドウを開きます。

  2. 「サービス」ウィンドウで「Mavenリポジトリ」ノードを展開します。

  3. リポジトリ・ノードを右クリックし、ポップアップ・メニューで「索引の更新」を選択します。

「索引を更新」をクリックすると、各Mavenリモート・リポジトリの最新の索引の有無が確認され、ダウンロードされます。索引は、リポジトリ内に存在するアーティファクトの現在の状態を示し、アプリケーションで使用できるアーティファクトへの参照を提供するために使用されます。デフォルトでは、アーティファクトが明示的に要求されないかぎり、リポジトリからアーティファクトはダウンロードされません。

索引のサイズが非常に大きく、すべてを更新するのに時間がかかる可能性があります。

NetBeans IDEでのMavenの使用に関する詳細は、Hibernateを使用したMaven Swingアプリケーションの作成チュートリアルのMavenの構成の項およびNetBeans IDEでのApache Mavenのベスト・プラクティスを参照してください。

エンタープライズ・アプリケーションの作成

この項では、エンティティ・クラスとそのエンティティ・クラスにアクセスするセッションBeanを含む単純なWebアプリケーションを作成します。

Webプロジェクトの作成

この課題では、新規プロジェクト・ウィザードを使用して、Maven原型からJava EE Webアプリケーションを作成します。ウィザードを使用してプロジェクトを作成するときは、ターゲット・サーバーとしてGlassFish Serverを指定します。

  1. メイン・メニューから「ファイル」>「新規プロジェクト」([Ctrl]-[Shift]-[N]、Macの場合は[⌘]-[Shift]-[N])を選択して新規プロジェクト・ウィザードを開きます。

  2. 「Maven」カテゴリから「Webアプリケーション」を選択します。「次」をクリックします。

  3. プロジェクト名を*mavenwebtestapp*にし、プロジェクトの場所を設定します。「次」をクリックします。

  4. 「サーバー」ドロップダウン・リストで「GlassFish Server」を選択します。

  5. 「Java EEバージョン」ドロップダウン・リストで「Java EE 6 Web」または「Java EE 7 Web」を選択します。「終了」をクリックします。

「終了」をクリックすると、IDEによってWebアプリケーションが作成され、プロジェクトが「プロジェクト」ウィンドウで開きます。

maven testing projects
Figure 1. 生成されたプロジェクトを示す「プロジェクト」ウィンドウ

「プロジェクト」ウィンドウでプロジェクト・ノードを展開すると、 javaee-web-api JARがプロジェクトの依存性として一覧表示され、JDKがJava依存性として一覧表示されていることがわかります。IDEによってプロジェクトのPOM ( pom.xml )が生成され、そのファイルが「プロジェクト・ファイル」ノードの下に一覧表示されます。

エンティティ・クラスの作成

この課題では、新規ファイル・ウィザードを使用してエンティティ・クラスを作成します。エンティティ・クラスを作成するときは、ウィザードで jdbc/sample データ・ソースを選択します。サーバーのインストール時に jdbc/sample データ・ソースが登録されたため、新しいデータ・ソースを作成または登録する必要はありません。

新しいデータソースを作成したり、異なるデータソースを使用する場合は、埋込みコンテナを使用してアプリケーションをテストする前に、そのデータソースをサーバーに登録する必要があります。埋込みコンテナを使用してアプリケーションをテストするときは、GlassFishサーバー・インスタンスにデプロイするときと同じように、データ・ソースがIDEによって自動的には登録されません。
  1. プロジェクト・ノードを右クリックし、「新規」>「エンティティ・クラス」を選択します。

または、メイン・メニューから「ファイル」>「新規ファイル」([Ctrl]-[N]、Macの場合は[⌘]-[N])を選択し、「持続性」カテゴリで「エンティティ・クラス」を選択することもできます。

  1. 「クラス名」に「MyEntity」と入力します。

  2. 「パッケージ」として「 com.mycompany.mavenwebtestapp 」を選択し、「主キー型」を* int *に設定します。

  3. 「持続性ユニットを作成」が選択されていることを確認します。「次」をクリックします。

  4. 「データ・ソース」ドロップダウン・リストで「jdbc/sample」を選択します。

  5. 「Java Transaction APIを使用」が選択されていることを確認し、「表生成戦略」として「ドロップして作成」を選択します。「終了」をクリックします。

maven testing pu
Figure 2. 生成されたプロジェクトを示す「プロジェクト」ウィンドウ

「終了」をクリックすると、IDEによってMyEntityクラスが生成され、ソース・エディタでクラスが開かれます。IDEによって、プロジェクト依存性として eclipselinkjavax.persistence および org.eclipse.persistence.jpa.modelgen.processor アーティファクトが追加されます。

  1. ソース・エディタで、クラスにprivateフィールド name を追加します。

private String name;
  1. エディタ内を右クリックし、「コードを挿入」ポップアップ・メニューで「取得メソッドおよび設定メソッド」を選択して name フィールドの取得メソッドと設定メソッドを生成します。

  2. 次のコンストラクタを追加します。

public MyEntity(int id) {
    this.id = id;
    name = "Entity number " + id + " created at " + new Date();
}
  1. MyEntity表のすべてのレコードを検索する名前付きSQL問合せを作成するために、以下の @NamedQueries および @NamedQuery 注釈(太字部分)を追加します。

@Entity
*@NamedQueries({
    @NamedQuery(name = "MyEntity.findAll", query = "select e from MyEntity e")})*
public class MyEntity implements Serializable {
  1. クラス宣言の左マージンにあるヒントをクリックして、「デフォルト・コンストラクタを作成」ヒントを選択します。

maven testing createconstructor
Figure 3. 生成されたプロジェクトを示す「プロジェクト」ウィンドウ
  1. インポート文を修正([Ctrl]-[Shift]-[I]、Macの場合は[⌘]-[Shift]-[I])して、 javax.persistence.NamedQueryjavax.persistence.NamedQueries および java.util.Date のインポート文を追加します。変更を保存します。

セッションBeanの作成

この課題では、ウィザードを使用して MyEntity エンティティ・クラスのセッション・ファサードを作成します。ウィザードを使用してファサードを生成すると、エンティティ・クラスにアクセスするときによく使用される createfind などのいくつかのメソッドを含む抽象ファサードもIDEによって生成されます。次に、ファサードに2つのメソッドを追加します。

  1. プロジェクト・ノードを右クリックし、「新規」>「その他」を選択します。

または、メイン・メニューから「ファイル」>「新規ファイル」([Ctrl]-[N]、Macの場合は[⌘]-[N])を選択して新規ファイル・ウィザードを開きます。

  1. 「Enterprise JavaBeans」カテゴリで「エンティティ・クラスのセッションBean」を選択します。「次」をクリックします。

  2. 「利用可能なエンティティ・クラス」のリストから MyEntity クラスを選択し、「追加」をクリックします。「次」をクリックします。

  3. ウィザードの「生成されるセッションBean」パネルで、デフォルトのプロパティを使用します。「終了」をクリックします。

「終了」をクリックすると、IDEによって com.mycompany.mavenwebtestapp パッケージ内に AbstractFacade.javaMyEntityFacade.java が生成され、ソース・エディタでこれらのクラスが開きます。

ソース・エディタで、IDEによって EntityManager のコードが生成され、持続性ユニットを指定するために @PersistenceContext 注釈が追加されたことを確認できます。

@Stateless
public class MyEntityFacade extends AbstractFacade<MyEntity> {
    @PersistenceContext(unitName = "com.mycompany_mavenwebtestapp_war_1.0-SNAPSHOTPU")
    private EntityManager em;

    @Override
    protected EntityManager getEntityManager() {
        return em;
    }

    public MyEntityFacade() {
        super(MyEntity.class);
    }

}
  1. MyEntityFacade.java に次のメソッドを追加します。

    @PermitAll
    public int verify() {
        String result = null;
        Query q = em.createNamedQuery("MyEntity.findAll");
        Collection entities = q.getResultList();
        int s = entities.size();
        for (Object o : entities) {
            MyEntity se = (MyEntity) o;
            System.out.println("Found: " + se.getName());
        }

        return s;
    }

    @PermitAll
    public void insert(int num) {
        for (int i = 1; i <= num; i++) {
            System.out.println("Inserting # " + i);
            MyEntity e = new MyEntity(i);
            em.persist(e);
        }
    }
  1. インポートを修正して必要なインポート文を追加します。変更を保存します。

maven testing fiximports
Figure 4. 生成されたプロジェクトを示す「プロジェクト」ウィンドウ
「すべてのインポートを修正」ダイアログ・ボックスで* javax.persistence.Query *が選択されていることを確認してください。

セッションBeanテストの作成

この項では、 MyEntityFacade セッション・ファサード用のJUnitテスト・クラスを作成します。IDEによって、ファサード・クラス内の各メソッドおよび抽象ファサード内の各メソッド用のスケルトン・テスト・メソッドが生成されます。抽象ファサード内のメソッド用に生成されたテスト・メソッドに注釈を付けて、IDEとJUnitテスト・ランナーにそれらを無視するように指示します。次に、 MyEntityFacade に追加した verify メソッド用のテスト・メソッドを変更します。

生成されたテストで、EJBコンテナのインスタンスを作成するために EJBContainer をコールするコードがIDEによって自動的に追加されることを確認します。

  1. 「プロジェクト」ウィンドウで「 MyEntityFacade.java 」を右クリックし、「ツール」→「テストを作成」を選択します。

  2. 「フレームワーク」ドロップダウン・リストからテスト・フレームワークを選択します。

  3. 「テストを作成」ダイアログ・ボックスのデフォルトのオプションを使用します。「OK」をクリックします。

JUnitテストを初めて作成するときは、JUnitフレームワークのバージョンを指定する必要があります。JUnitのバージョンとして「JUnit 4.x」を選択し、「選択」をクリックします。

デフォルトでは、IDEによって MyEntityFacade および AbstractFacade 内の各メソッド用のテストを含むスケルトン・テスト・クラスが生成されます。IDEによってJUnit 4.10への依存性がPOMに自動的に追加されます。

  1. testVerify を除く各テスト・メソッドに @Ignore 注釈を付けます。テストを実行すると、IDEによって @Ignore 注釈の付いた各テストがスキップされます。

または、 testVerify 以外のすべてのテスト・メソッドを削除することもできます。

  1. テスト・クラス内の testVerify テスト・メソッドを見つけます。

    ``EJBContainer`` をコールする行がテストに含まれていることがわかります。
    @Test
    public void testVerify() throws Exception {
        System.out.println("verify");
        EJBContainer container = javax.ejb.embeddable.EJBContainer.createEJBContainer();
        MyEntityFacade instance = (MyEntityFacade)container.getContext().lookup("java:global/classes/MyEntityFacade");
        int expResult = 0;
        int result = instance.verify();
        assertEquals(expResult, result);
        container.close();
        // TODO review the generated test code and remove the default call to fail.
        fail("The test case is a prototype.");
    }
  1. testVerify テスト・メソッドのスケルトンに以下の変更(太字部分)を加えます。

@Test
public void testVerify() throws Exception {
    System.out.println("verify");
    EJBContainer container = javax.ejb.embeddable.EJBContainer.createEJBContainer();
    MyEntityFacade instance = (MyEntityFacade)container.getContext().lookup("java:global/classes/MyEntityFacade");
    *System.out.println("Inserting entities...");
    instance.insert(5);*
    int result = instance.verify();
    *System.out.println("JPA call returned: " + result);
    System.out.println("Done calling EJB");
    Assert.assertTrue("Unexpected number of entities", (result == 5));*
    container.close();
}
  1. インポート文を修正して junit.framework.Assert を追加します。変更を保存します。

ここでPOMを変更して、GlassFishサーバーのローカル・インストールにある <glassfish.embedded-static-shell.jar> に対する依存性を追加する必要があります。

  1. エディタで pom.xml を開き、 <properties> 要素を見つけます。

    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
  1. <properties> 要素を編集して、ローカルGlassFishインストールのJARの場所を指定する <glassfish.embedded-static-shell.jar> 要素(*太字*部分)を追加します。このプロパティをアーティファクトに対する依存性で参照します。

    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        *<glassfish.embedded-static-shell.jar>_<INSTALLATION_PATH>_/glassfish-4.0/glassfish/lib/embedded/glassfish-embedded-static-shell.jar</glassfish.embedded-static-shell.jar>*

    </properties>
<INSTALLATION_PATH> は、ローカルGlassFishインストールの絶対パスです。ローカル・インストールへのパスが変更された場合は、POM内のこの要素を変更する必要があります。
  1. 「プロジェクト」ウィンドウの「依存性」ノードを右クリックし、「依存性の追加」を選択します。

  2. 「依存性の追加」ダイアログ・ボックスで、「問合せテキスト」フィールドに*「embedded-static-shell」*と入力します。

  3. 検索結果で4.0 JARを見つけ、「追加」をクリックします。

add shell dependency
Figure 5. 「テスト結果」ウィンドウ

「追加」をクリックすると、IDEによってPOMに依存性が追加されます。

ここでPOMを変更して、GlassFishのローカル・インストールをJARのソースとして指定します。

  1. POMで依存性を見つけ、次のように(*太字*部分)、追加した <glassfish.embedded-static-shell.jar> プロパティを参照し、 <scope> を指定するよう要素を変更します。変更を保存します。

        <dependency>
            <groupId>org.glassfish.main.extras</groupId>
            <artifactId>glassfish-embedded-static-shell</artifactId>
            <version>4.0</version>
            *<scope>system</scope>
            <systemPath>${glassfish.embedded-static-shell.jar}</systemPath>*
        </dependency>
  1. 「サービス」ウィンドウで「GlassFish Server」ノードを右クリックし、「起動」を選択します。

GlassFish Serverを起動すると、JavaDBデータベース・サーバーも起動します。

  1. 「プロジェクト」ウィンドウでプロジェクト・ノードを右クリックし、「テスト」を選択します。

「テスト」を選択すると、IDEによってアプリケーションがビルドされ、ビルド・ライフサイクルのテスト・フェーズが実行されます。この単体テストは、JUnit 4.xテストの実行をサポートするsurefireプラグインを使用して実行されます。surefireプラグインの詳細は、http://maven.apache.org/plugins/maven-surefire-plugin/を参照してください。

「テスト結果」ウィンドウにテストの結果が表示されます。「テスト結果」ウィンドウは、メイン・メニューから「ウィンドウ」→「出力」→「テスト結果」を選択して開くことができます。

maven test results
Figure 6. 「テスト結果」ウィンドウ

「テスト結果」ウィンドウで、「成功したものを表示」アイコン(test ok 16)をクリックして、成功したすべてのテストのリストを表示できます。この例では、9個のテストに成功したことがわかります。「出力」ウィンドウを見ると、1個のテストのみが実行され、8個のテストがスキップされたことを確認できます。スキップされたテストは、「テスト結果」ウィンドウの成功したテストのリストに含まれます。

Running com.mycompany.mavenwebtestapp.MyEntityFacadeTest
verify
...
Inserting entities...
Inserting # 1
Inserting # 2
Inserting # 3
Inserting # 4
Inserting # 5
Found: Entity number 2 created at Wed Oct 09 19:06:59 CEST 2013
Found: Entity number 4 created at Wed Oct 09 19:06:59 CEST 2013
Found: Entity number 3 created at Wed Oct 09 19:06:59 CEST 2013
Found: Entity number 1 created at Wed Oct 09 19:06:59 CEST 2013
Found: Entity number 5 created at Wed Oct 09 19:06:59 CEST 2013
JPA call returned: 5
Done calling EJB
...

Results :

Tests run: 9, Failures: 0, Errors: 0, Skipped: 8

関連項目

NetBeans IDEを使用したJava EEアプリケーションの開発方法の詳細は、次のリソースを参照してください。

エンタープライズBeanの使用方法については、Java EE 6チュートリアルを参照してください。

nbj2eeメーリング・リストに登録することによって、NetBeans IDE Java EE開発機能に関するご意見やご提案を送信したり、サポートを受けたり、最新の開発情報を入手したりできます。