server-common/src/test/java/org/apache/kafka/server/util/MockTime.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.kafka.server.util;

/**
 * A class used for unit testing things which depend on the Time interface.
 * There a couple of difference between this class and `org.apache.kafka.common.utils.MockTime`:
 *
 * 1. This has an associated scheduler instance for managing background tasks in a deterministic way.
 * 2. This doesn't support the `auto-tick` functionality as it interacts badly with the current implementation of `MockScheduler`.
 */
public class MockTime extends org.apache.kafka.common.utils.MockTime {
    public final MockScheduler scheduler;

    public MockTime() {
        this(System.currentTimeMillis(), System.nanoTime());
    }

    public MockTime(long currentTimeMs, long currentHiResTimeNs) {
        super(0L, currentTimeMs, currentHiResTimeNs);
        scheduler = new MockScheduler(this);
    }

    @Override
    public void sleep(long ms) {
        super.sleep(ms);
        scheduler.tick();
    }
}