読者です 読者をやめる 読者になる 読者になる

mike-neckのブログ

JavaかJavaFXかJavaEE(なんかJava8が多め)

sdkmanでJavaのインストール

java

結構前のことですが、 sdkmanJavaをインストールできるようになったとのことで、Javaの更新をsdkmanでやるようにしてみた。

sdk list java

まず、どのバージョンのJavaが利用できるのか確認してみます。

$ sdk list java

================================================================================
Available Java Versions
================================================================================
     8u111                                                                         
     7u79                                                                          
     6u65                                                                          

================================================================================
+ - local version
* - installed
> - currently in use
================================================================================

sdk install java 7u79

Java7をインストールしてみます。

$ sdk install 7u79

Oracle requires that you agree with the Oracle Binary Code License Agreement
prior to installation. The license agreement can be found at:

  http://www.oracle.com/technetwork/java/javase/terms/license/index.html

Do you agree to the terms of this agreement? (Y/n): 

まず、ライセンスアグリーメントが求められます。ここは y でよいです。

Downloading: java 7u79

In progress...

######################################################################## 100.0%
Binary validation passed...
We will be needing super powers...
Password:

Repackaging java 7u79...
Attaching to the DMG...
Mounting DMG as Volume...
Volume(s) mounted successfully
Installing PKG inside DMG...
installer: Package name is JDK 7 Update 79
installer: Installing at base path /
installer: The install was successful.
Copy JDK Home to temp folder...
Preparing archive...
Unmounting volume...
"/Volumes/JDK 7 Update 79" unmounted successfully.
Done repackaging...
Cleaning up cookie...

Installing: java 7u79
Done installing!

Do you want java 7u79 to be set as default? (Y/n): n

Java7はあまり使うものではないのでデフォルトは n にしておきます。


注意 - Javaのインストール先と JAVA_HOME の場所

sdkJavaをインストールする場合は以下の点に注意が必要です(Macでのみ確認)。

  • Javaのインストール先がいつもどおりの /Library/Java/JavaVirtualMachines に加えて /Users/my-home/.sdkman/candidates/java にもコピーがインストールされます。
  • sdkスクリプトによって JAVA_HOME/Library/Java/JavaVirtualMachines ではなく、 /Users/my-home/.sdkman/candidates/java の方に向きます。
    • したがって、 JAVA_HOME/usr/libexec/java_home を用いて設定/切り替えしていた場合などは JAVA_HOMEPATH が指しているパスが異なるという気持ち悪い状態になるかもしれません。

lombokで生成されたgetterにアノテーションを付与する方法と問題

java

lombokの既存バグにハマったので、その一時的な回避策のメモ。

なお、この情報は以下の環境でおこなった。

  • Java - 1.8.0_102
  • lombok - 1.16.12

なお、issueはこちら。

github.com


lombokで生成されるgetter(あるいはsetter)にアノテーションを付与する方法

GetteronMethod に特殊な記述法でついてほしいアノテーションを渡す。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Bool {
  @Getter(onMethod = @__({ @XmlAttribute }))
  private boolean value;
}

問題 - onMethod で渡すアノテーションにプロパティを設定するとコンパイルで落ちる

lombokのonXのドキュメントを読むかぎり、 onMethod に渡すアノテーションにプロパティが設定されていてもうまくコンパイルされるようである。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Int {
  @Getter(onMethod = @__({ @XmlAttribute(name = "int") }))
  private int value;
}

ところが、これをコンパイルすると次のようなエラーが発生してコンパイルが失敗する。

/path/to/project/src/main/java/foo/bar/Int.java:13: エラー: シンボルを見つけられません
    @Getter(onMethod = @__({ @XmlAttribute(name = "int") }))
                        ^
  シンボル:   クラス __
  場所: クラス Int
/path/to/project/src/main/java/foo/bar/Int.java:13: エラー: 注釈@<any?>に重複y?>'があります。
    @Getter(onMethod = @__({@XmlAttribute(name = "int")}))
                                          ^

回避策 - getterを手で書く

回避策がlombokを入れた意味があまりなくなってしまう方法で非常に残念である。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Int {
  private int value;
  @XmlAttribute(name = "int")
  public int getValue() {
    return value;
  }
}

JUnit5入門(6) - JUnit5とGuiceでDIが必要なオブジェクトを構築してテストする

java

前回の続き

これまでの内容をまとめて、DIが必要なオブジェクトをテストするやり方(のひとつ)をやってみる。DIにはGuiceを用いる。


環境

JDK|1.8.0_102 junit-jupiter-api|5.0.0-M3 junit-platform-engine|1.0.0-M3 guice|4.1.0


テスト対象のインターフェース

次のようなインターフェース/実装クラスをテストする。

インターフェース
public interface DateService {

  Locale getLocale();

  String date(int year, int month, int day);

  String today();

  String time(int hour, int minutes);

  String now();

  ZoneId getZone();
}
実装クラス
public class DateServiceImpl implements DateService {

  private final ZoneId zone;
  private final DateTimeFormatter dateFormat;
  private final DateTimeFormatter timeFormat;
  private final Locale locale;

  @Inject
  public DateServiceImpl(
      ZoneId zone
      , @Date DateTimeFormatter dateFormat
      , @Time DateTimeFormatter timeFormat
      , Locale locale
  ) {
    this.zone = zone;
    this.dateFormat = dateFormat.withLocale(locale);
    this.timeFormat = timeFormat.withLocale(locale);
    this.locale = locale;
  }

  @Override
  public Locale getLocale() {
    return locale;
  }
  @Override
  public String date(int year, int month, int day) {
    return LocalDate.of(year, month, day).format(dateFormat);
  }
  @Override
  public String today() {
    return LocalDate.now(zone).format(dateFormat);
  }
  @Override
  public String time(int hour, int minutes) {
    return LocalTime.of(hour, minutes).format(timeFormat);
  }
  @Override
  public String now() {
    return LocalDateTime.now(zone).format(timeFormat);
  }
  @Override
  public ZoneId getZone() {
    return zone;
  }
}

@Date@Timeバインディングアノテーション


テスト

guiceでオブジェクトを構築する ExtensionDateServiceGuiceExtension と名前をつけるとして、テストは次のような感じにする。

@DisplayName("DateServiceのテスト - 実装はDateServiceImpl")
public class DateServiceTest {
  @Nested
  @DisplayName("ロケールはen日付はMMM/d/uu,時刻はhh:mm,America/Los_Angeles")
  @Lang("en")
  @Date.Format("MMM/d/uu")
  @Time.Format("hh:mm")
  @Zone("America/Los_Angeles")
  @ExtendWith({ DateServiceGuiceExtension.class })
  class LosAngelesTest {
    @Test
    @DisplayName("dateの最初の3文字は英字")
    void first3CharactersIsAlphabet(DateService service) {
      final String today = service.today();
      assertTrue(today.substring(0, 3).matches("\\p{Alpha}{3}"));
    }
    @Test
    @DisplayName("時刻は必ず2文字ある")
    void hourHasTwoCharacters(DateService service) {
      final String now = service.now();
      assertEquals(2, now.split(":")[0].length());
    }
    @Test
    @DisplayName("タイムゾーンはAsia/Tokyoではない")
    void timeZoneIsNotAsiaTokyo(DateService service) {
      final ZoneId zone = service.getZone();
      assertNotEquals(of("Asia/Tokyo"), zone);
    }
  }
  @Nested
  @DisplayName("ロケール指定なし(デフォルト)/Dateの指定なし(uuuu/MM/dd)/Timeの指定なし(HH:mm:ss.SSS)/Zoneの指定なし(UTC)")
  @ExtendWith({ DateServiceGuiceExtension.class })
  class DefaultInjection {
    @Test
    @DisplayName("日付のフォーマットの確認")
    void validateDateFormat(DateService service) {
      assertAll(
          () -> assertEquals("2017/01/01", service.date(2017, 1, 1))
          , () -> assertEquals("2016/11/11", service.date(2016, 11, 11))
      );
    }
    @Test
    @DisplayName("時刻のフォーマットの確認")
    void validateTimeFormat(DateService service) {
      assertAll(
          () -> assertEquals("04:00:00.000", service.time(4, 0))
          , () -> assertEquals("13:13:00.000", service.time(13, 13))
      );
    }
  }
}

Extension の実装

ExtensionBeforeAllCallbackAfterAllCallbackParameterResolver を実装します。

  • BeforeAllCallback にてテストクラスの情報から必要な Injector を生成します。
  • ParameterResolver でテストが必要としているオブジェクトを解決します。
  • AfterAllCallback にて Injector を破棄します。
BeforeAllCallback/AfterAllCallback の実装
public abstract class GuiceExtension implements
    ParameterResolver
    , BeforeAllCallback
    , AfterAllCallback
{
  private static final Namespace GUICE = Namespace.create(com.example.guice.GuiceExtension.class);
  private static Store getStore(ExtensionContext context) {
    return context.getStore(GUICE);
  }

  abstract protected Module prepareModule(
      @NotNull Class<?> testClass
      , @NotNull Set<String> tags
      , @SuppressWarnings("OptionalUsedAsFieldOrParameterType")
        @NotNull 
            Optional<AnnotatedElement> annotations
  );

  @Override
  public void beforeAll(ContainerExtensionContext context) throws Exception {
    final Store store = getStore(context);
    final Optional<AnnotatedElement> annotations = context.getElement();
    context.getTestClass()
        .map(c -> prepareModule(c, context.getTags(), annotations))
        .map(Guice::createInjector)
        .ifPresent(i -> store.put(Injector.class, i));
  }

  @Override
  public void afterAll(ContainerExtensionContext context) throws Exception {
    getStore(context).remove(Injector.class, Injector.class);
  }
}

このクラスを継承するクラスは、テストクラスに与えられたメタ情報(タグ/アノテーション)情報を元に、 Module を作ります。このクラスは Module から Injector を作りコンテキストに保持します。JUnit5のドキュメントによると Extensionインスタンスはテスト実行中に1つしか作られないので、テストの状態は Extension のフィールドには持たせずに Context が保持する Store に保持させるようにします。

ParameterResolver の実装

Store からテストクラスをキーにして Injector を取得し、さらにパラメーターの型、パラメーターに付与されたバインディングアノテーションをキーにしてインスタンスを取得します。

@Override
public boolean supports(
    ParameterContext parameterContext
    , ExtensionContext extensionContext
) throws ParameterResolutionException {
  final Parameter parameter = parameterContext.getParameter();
  final Class<?> paramType = parameter.getType();
  final Stream<? extends Key<?>> keyStream = Arrays
      .stream(parameter.getAnnotations())
      .map(a -> Key.get(paramType, a));
  return extensionContext.getTestClass()
      .map(c -> getStore(extensionContext).get(c, Injector.class))
      .map(Injector::getAllBindings)
      // a -> (a,a)
      .map(Pair.createPair(Function.identity()))
      // (a -> Bool) -> (b -> Bool) -> (a,b) -> Bool
      .filter(Pair.orFilterPair(
          b -> b.containsKey(Key.get(paramType))
          , b -> keyStream.anyMatch(b::containsKey)
      )).isPresent();
}
@Override
public Object resolve(
    ParameterContext parameterContext
    , ExtensionContext extensionContext
) throws ParameterResolutionException {
  final Parameter parameter = parameterContext.getParameter();
  final Class<?> paramType = parameter.getType();
  final Annotation[] annotations = parameter.getAnnotations();
  return extensionContext.getTestClass()
      .map(c -> getStore(extensionContext).get(c, Injector.class))
      .map(Injector::getAllBindings)
      // a -> (a, b)
      .map(Pair.createPair(b -> b.get(Key.get(paramType))))
      // (a, b) -> (b -> Maybe b) -> (a, Maybe b)
      .map(Pair.mapPair(Optional::ofNullable))
      // (a, Maybe b) -> (b -> c) -> (a, Maybe c)
      .map(Pair.mapPair(o -> o.map(Binding::getProvider)))
      // (a, Maybe c) -> (c -> Maybe t) -> (a, Maybe (Maybe t))
      .map(Pair.mapPair(o -> o.map(p -> (Object) p.get())))
      .map(Pair.mapPair(o -> o.map(Optional::of)))
      // (a, Maybe (Maybe t)) -> (a -> Maybe t -> Maybe t) -> Maybe t
      .flatMap(Pair.transformPair((m, o) -> o.orElseGet(
          // returns Optional<Object>
          findBindingByClassAndAnnotation(paramType, annotations, m))))
      .orElseThrow(() -> new ParameterResolutionException(
          String.format(
              "System cannot find binding for type: [%s] parameter index: %d"
              , parameter.getType()
              , parameterContext.getIndex())
      ));
}

これでテストを実行すると次のようになります。

f:id:mike_neck:20170103205333p:plain


なお、サンプルコードはこちらにあります。

github.com

JUnit入門(5) - JUnit5の拡張(Extension)

java

前回の続き

JUnitExtension インターフェース

JUnit4のRunnerと同様、JUnit5も拡張をすることができる。

JUnit5が提供している 拡張インターフェース(Extension を継承したインターフェース)は次のとおり。

  • ContainerExecutionCondition
    • メソッド - evaluate(ContainerExtensionContext)
      • 戻り値の型 - ConditionEvaluationResult
    • テストクラスレベルで実行可否の判断する
  • TestExecutionCondition
    • メソッド - evaluate(TestExtensionContext)
      • 戻り値の型 - ConditionEvaluationResult
    • テストメソッドの実行可否の判断する
  • BeforeAllCallback
    • メソッド - beforeAll(ContainerExtensionContext)
      • 戻り値の型 - void
    • @BeforeAll の前に実行される
  • BeforeEachCallback
    • メソッド - beforeEach(TestExtensionContext)
      • 戻り値の型 - void
    • @BeforeEach の前に実行される
  • BeforeTestExecutionCallback
    • メソッド - beforeTestExecution(TestExtensionContext)
      • 戻り値の型 - void
    • テスト(@Test)の前に実行される
  • AfterTestExecutionCallback
    • メソッド - afterTestExecution(TestExtensionContext)
      • 戻り値の型 - void
    • テスト(@Test)の後に実行される
  • AfterEachCallback
    • メソッド - afterEach(TestExtensionContext)
      • 戻り値の型 - void
    • @AfterEach` の後に実行される
  • AfterAllCallback
    • メソッド - afterAll(ContainerExtensionContext)
      • 戻り値の型 - void
    • @AfterAll の後に実行される
  • TestInstancePostProcessor
    • メソッド - postProcessTestInstance(Object, ExtensionContext)
      • 戻り値の型 - void
    • テストクラスのインスタンス生成後に実行される
  • TestExecutionExceptionHandler
    • メソッド - handleTestExecutionException(TestExtensionContext, Throwable)
      • 戻り値の型 - void
    • テスト時に発生した例外の扱いを決定する
  • ParameterResolver
    • メソッド - supports(ParameterContext, ExtensionContext)
      • 戻り値の型 - boolean
    • メソッド - resolve(ParameterContext, ExtensionContext)
      • 戻り値の型 - Object
    • テストメソッドに与える引数を解決する

テストライフサイクル

これらの Extension は次の順番でテストクラスの生成、テストの実行、テスト終了までの一連の流れに組み込まれる。

  1. ContainerExecutionCondition
  2. BeforeAllCallback
  3. テストクラスの @BeforeAll
  4. テストクラスのインスタンス生成
  5. TestInstancePostProcessor

ここから、テストがある場合

  1. TestExecutionCondition
  2. BeforeEachCallback
  3. テストクラスの @BeforeEach
  4. BeforeTestExecutionCallback
  5. ParameterResolver#supports(引数の数だけ)
  6. ParameterResolver#resolve(引数の数だけ)
  7. テストクラスの @Test(テスト)
  8. TestExecutionExceptionHandler(テスト中に例外が発生した場合だけ)
  9. AfterTestExecutionCallback
  10. テストクラスの @AfterEach
  11. AfterEachCallback

ここから、同じクラスに他のテストがある場合

  1. 次のテストのインスタンス生成
  2. TestInstancePostProcessor
  3. TestExecutionCondition
  4. ...
  5. AfterEachCallback

ここから、ネストしたクラスがある場合

  1. ContainerExecutionCondition
  2. BeforeAllCallback
  3. アウタークラスのインスタンス生成
  4. TestInstancePostProcessor
  5. インナークラスのインスタンス生成
  6. TestInstancePostProcessor
  7. TestExecutionCondition
  8. BeforeEachCallback
  9. アウタークラスの @BeforeEach
  10. インナークラスの @BeforeEach
  11. BeforeTestExecutionCallback
  12. ParameterResolver#supports(引数の数だけ)
  13. ParameterResolver#resolve(引数の数だけ)
  14. テストクラスの @Test(テスト)
  15. TestExecutionExceptionHandler(テスト中に例外が発生した場合だけ)
  16. AfterTestExecutionCallback
  17. インナークラスの @AfterEach
  18. アウタークラスの @AfterEach
  19. AfterEachCallback

ここから、インナークラスにテストがない場合

  1. AfterAllCallback

ここから、他にテストがない場合

  1. テストクラスの @AfterAll
  2. AfterAllCallback

確認コードはこちらにある、 NestedClasses.java/NoTest.java/TestLifecycleCallbacks.java を参照。

github.com


Extension の登録

実装した Extension@ExtendWith アノテーションをクラスまたはメソッドに指定することによって登録できる。

@ExtendWith({ FooExtension.class, BarExtension.class })
public class FooTest {
  @Test
  @ExtendWith(BazExtension.class)
  void qux() {}
}

なお、残念なことにjunit-jupiter-apiにはデフォルトで提供されている Extension はない。したがって、JUnit4で ExternalResource とか TestName を使っていた場合は、自分で Extension を書かなければならない(まあ、誰かがそのうち作ってくれるだろうけど…)。

各インターフェースの詳細

ContainerExecutionCondition/TestExecutionCondition

テストコンテナ(テストクラス)/テスト(テストメソッド)の条件に基づき実行制御を判断するメソッドを提供するインターフェース。それぞれ ContainerExecutionContext および TestExtensionContext を引数にとって、 ConditionEvaluationResult を返す。 ContainerEvaluationResult はstaticメソッド enabled(String)(テストを実行する)または disabled(テストを実行しない)によって生成できるオブジェクト。アノテーション @Disabled によってテストの実行制御を行っているのも、このインターフェースを実装した DisabledConditionによる。

サンプルコード : 指定した曜日しか動かないテスト

github.com

テスト中のサービスの起動状態によって、モックを使ったテストを実行する/テスト中のサービスでテストを実行するなどの切り替えに使えるかもしれない(それなら Condition でやるよりも ParameterResolver の方がよいけど…)。


Callback インターフェース

テストの各種フェーズをhookにして起動できる処理を定義する。起動される順序は上述のとおり。またJUnit5のドキュメントに書かれているようにテストの実行時間を計測したい場合は、テストクラスの @BeforeEach/@AfterEach ではなく @BeforeTestExecutionCallback および @AfterTestExecutionCallback によって計測するほうがより正確な実行時間が計測できる。


例外ハンドリング

TestExecutionExceptionHandler によって例外発生時の処理を挟み込むことができる。まあ、特定の例外は無視するくらいの使いみちしかないと思われるが…

TestInstancePostProcessor

テストクラスのインスタンスを起動した後に、特定の処理をおこないたい場合やDI、モックの準備をしたい場合などに作る。

サンプルコード

@PostConstruct アノテーションが付与されているメソッドを起動する TestInstancePostProcessor

public class PostProcessor implements TestInstancePostProcessor {

  private static final Predicate<Method> annotatedWithPostConstruct =
      m -> m.isAnnotationPresent(PostConstruct.class);

  @NotNull
  private static Consumer<Method> invokePostConstruct(
      @NotNull Object o
  ) {
    return m -> {
      try {
        m.setAccessible(true);
        m.invoke(o);
      } catch (IllegalAccessException | InvocationTargetException e) {
        final String name = m.getName();
        throw new IllegalStateException(name + " method cannot be invoked.", e);
      }
    };
  }

  @Override
  public void postProcessTestInstance(
      Object test
      , ExtensionContext context
  ) throws Exception {
    Stream.of(test.getClass().getDeclaredMethods())
        .filter(annotatedWithPostConstruct)
        .findAny()
        .ifPresent(invokePostConstruct(test));
  }
}

サンプルコード続きはこちら

github.com


ParameterResolver

ParameterResolver はテストメソッドの引数を解決するインターフェース。 support メソッドで引数を渡すことができるか判断し、引数を渡せる場合に resolve メソッドで実際の引数を渡す。メソッドに引数を渡せると聞くと、それ自身がテストのassertionの対象となる値を渡せると捉えがちだが、どちらかというとテストに関するメタ情報や特別な処理が必要になるオブジェクト(DI管理のオブジェクトやDIの対象となるオブジェクト、モックオブジェクトなど)を引数にとるようにする。(テストのためのパラメーターについては、 DynamicTest で作ればよく、テストのメソッドの引数にはそのパラメーターを作るためのオブジェクト(例えば File など)を渡した方がよい)。

サンプルコード

@InputString アノテーションを付与した String 型の引数に @InputString のパラメーターで指定した文字列を渡す。

github.com