test/com/facebook/buck/event/BuckEventBusTest.java

/*
 * Copyright 2014-present Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package com.facebook.buck.event;

import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.lessThanOrEqualTo;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;

import com.facebook.buck.timing.DefaultClock;
import com.facebook.buck.timing.SettableFakeClock;
import com.facebook.buck.util.concurrent.MoreExecutors;
import com.google.common.eventbus.Subscribe;

import org.junit.Test;

import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class BuckEventBusTest {

  private static final int timeoutMillis = 500;

  @Test
  public void testShutdownSuccess() throws Exception {
    BuckEventBus eb = new BuckEventBus(
        new DefaultClock(),
        MoreExecutors.newSingleThreadExecutor(BuckEventBus.class.getSimpleName()),
        BuckEventBusFactory.BUILD_ID_FOR_TEST,
        timeoutMillis);
    eb.register(new SleepSubscriber());
    eb.post(new SleepEvent(1));
    long start = System.nanoTime();
    eb.close();
    long durationNanos = System.nanoTime() - start;
    long durationMillis = TimeUnit.MILLISECONDS.convert(durationNanos, TimeUnit.NANOSECONDS);
    assertThat("Shutdown should not take a long time.",
        durationMillis, lessThanOrEqualTo((long) timeoutMillis));
  }

  @Test
  public void testShutdownFailure() throws IOException {
    BuckEventBus eb = new BuckEventBus(
        new DefaultClock(),
        MoreExecutors.newSingleThreadExecutor(BuckEventBus.class.getSimpleName()),
        BuckEventBusFactory.BUILD_ID_FOR_TEST,
        timeoutMillis);
    eb.register(new SleepSubscriber());
    eb.post(new SleepEvent(timeoutMillis * 3));
    long start = System.nanoTime();
    eb.close();
    // We'd like to test the Logger output here, but there's not a clean way to do that.
    long durationNanos = System.nanoTime() - start;
    long durationMillis = TimeUnit.MILLISECONDS.convert(durationNanos, TimeUnit.NANOSECONDS);
    assertThat("Shutdown should not take a long time.",
        durationMillis, lessThanOrEqualTo((long) timeoutMillis * 2));
  }

  @Test
  public void whenEventTimestampedThenEventCannotBePosted() throws IOException {
    BuckEventBus eb = new BuckEventBus(
        new DefaultClock(),
        MoreExecutors.newSingleThreadExecutor(BuckEventBus.class.getSimpleName()),
        BuckEventBusFactory.BUILD_ID_FOR_TEST,
        timeoutMillis);
    TestEvent event = new TestEvent();
    eb.timestamp(event);
    try {
      eb.post(event);
      fail("Post should throw IllegalStateException.");
    } catch (IllegalStateException e) {
      assertThat(
          "Exception should be due to double configuration.",
          e.getMessage(),
          containsString("Events can only be configured once."));
    } finally {
      eb.close();
    }
  }

  @Test
  public void whenEventPostedWithAnotherThenTimestampCopiedToPostedEvent() throws IOException {
    BuckEventBus eb = new BuckEventBus(
        new DefaultClock(),
        MoreExecutors.newSingleThreadExecutor(BuckEventBus.class.getSimpleName()),
        BuckEventBusFactory.BUILD_ID_FOR_TEST,
        timeoutMillis);
    TestEvent timestamp = new TestEvent();
    TestEvent event = new TestEvent();
    eb.timestamp(timestamp);
    eb.post(event, timestamp);
    eb.close();
    assertEquals(timestamp.getTimestamp(), event.getTimestamp());
    assertEquals(timestamp.getNanoTime(), event.getNanoTime());
  }

  @Test
  public void timestampedEventHasSeparateNanosAndMillis() throws IOException {
    SettableFakeClock fakeClock = new SettableFakeClock(49152, 64738);
    BuckEventBus eb = new BuckEventBus(
        fakeClock,
        MoreExecutors.newSingleThreadExecutor(BuckEventBus.class.getSimpleName()),
        BuckEventBusFactory.BUILD_ID_FOR_TEST,
        timeoutMillis);
    TestEvent event = new TestEvent();
    eb.post(event);
    eb.close();
    assertEquals(event.getTimestamp(), 49152);
    assertEquals(event.getNanoTime(), 64738);
  }

  private static class SleepEvent extends AbstractBuckEvent {
    public final long milliseconds;

    private SleepEvent(long milliseconds) {
      this.milliseconds = milliseconds;
    }

    @Override
    protected String getValueString() {
      return null;
    }

    @Override
    public boolean isRelatedTo(BuckEvent event) {
      return false;
    }

    @Override
    public String getEventName() {
      return null;
    }
  }

  private static class SleepSubscriber {
    @Subscribe
    public void sleep(SleepEvent event) throws InterruptedException {
      Thread.sleep(event.milliseconds);
    }
  }

  private static class TestEvent extends AbstractBuckEvent {

    @Override
    protected String getValueString() {
      return "Test event, please ignore.";
    }

    @Override
    public boolean isRelatedTo(BuckEvent event) {
      return false;
    }

    @Override
    public String getEventName() {
      return "TestEvent";
    }
  }
}