atris commented on code in PR #20187: URL: https://github.com/apache/flink/pull/20187#discussion_r916570822
########## flink-runtime/src/test/java/org/apache/flink/runtime/scheduler/metrics/SubStateTimeMetricsTest.java: ########## @@ -0,0 +1,624 @@ +/* + * 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.flink.runtime.scheduler.metrics; + +import org.apache.flink.configuration.MetricOptions; +import org.apache.flink.runtime.execution.ExecutionState; +import org.apache.flink.runtime.executiongraph.ExecutionAttemptID; +import org.apache.flink.runtime.jobgraph.JobType; +import org.apache.flink.util.clock.ManualClock; + +import org.junit.jupiter.api.Test; + +import java.time.Duration; + +import static org.apache.flink.runtime.executiongraph.ExecutionGraphTestUtils.createExecutionAttemptId; +import static org.apache.flink.runtime.scheduler.metrics.StateTimeMetricTest.enable; +import static org.assertj.core.api.Assertions.assertThat; + +/** Tests for SubStateTime metrics. */ +public class SubStateTimeMetricsTest { + private static final MetricOptions.JobStatusMetricsSettings settings = + enable( + MetricOptions.JobStatusMetrics.STATE, + MetricOptions.JobStatusMetrics.CURRENT_TIME, + MetricOptions.JobStatusMetrics.TOTAL_TIME); + + @Test + void testInitialValues() { + final ManualClock clock = new ManualClock(Duration.ofMillis(5).toNanos()); + + final SubStateTimeMetrics initializationStateTimeMetrics = + new SubStateTimeMetrics( + JobType.BATCH, settings, ExecutionState.DEPLOYING, clock, "deploying"); + + assertThat(initializationStateTimeMetrics.getCurrentTime()).isEqualTo(0L); + assertThat(initializationStateTimeMetrics.getTotalTime()).isEqualTo(0L); + assertThat(initializationStateTimeMetrics.getBinary()).isEqualTo(0L); + } + + @Test + void testInitializingOnFirstInitialization() { + final SubStateTimeMetrics metrics = + new SubStateTimeMetrics( + JobType.BATCH, settings, ExecutionState.INITIALIZING, "initialising"); + + final ExecutionAttemptID id1 = createExecutionAttemptId(); + + metrics.onStateUpdate(id1, ExecutionState.CREATED, ExecutionState.SCHEDULED); + assertThat(metrics.getBinary()).isEqualTo(0L); + + metrics.onStateUpdate(id1, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + assertThat(metrics.getBinary()).isEqualTo(0L); + + metrics.onStateUpdate(id1, ExecutionState.DEPLOYING, ExecutionState.INITIALIZING); + assertThat(metrics.getBinary()).isEqualTo(1L); + } + + @Test + void testInitializingStart_batch_notTriggeredIfOneDeploymentIsRunning() { + final SubStateTimeMetrics metrics = + new SubStateTimeMetrics( + JobType.BATCH, settings, ExecutionState.INITIALIZING, "initialising"); + + final ExecutionAttemptID id1 = createExecutionAttemptId(); + + metrics.onStateUpdate(id1, ExecutionState.CREATED, ExecutionState.SCHEDULED); + metrics.onStateUpdate(id1, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + metrics.onStateUpdate(id1, ExecutionState.DEPLOYING, ExecutionState.INITIALIZING); + metrics.onStateUpdate(id1, ExecutionState.INITIALIZING, ExecutionState.RUNNING); + + final ExecutionAttemptID id2 = createExecutionAttemptId(); + + metrics.onStateUpdate(id2, ExecutionState.CREATED, ExecutionState.SCHEDULED); + metrics.onStateUpdate(id2, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + metrics.onStateUpdate(id2, ExecutionState.DEPLOYING, ExecutionState.INITIALIZING); + + assertThat(metrics.getBinary()).isEqualTo(0L); + } + + @Test + void testOneInitializingAndOneDeploying_batch() { + final SubStateTimeMetrics metrics = + new SubStateTimeMetrics( + JobType.BATCH, settings, ExecutionState.INITIALIZING, "initialising"); + + final ExecutionAttemptID id1 = createExecutionAttemptId(); + final ExecutionAttemptID id2 = createExecutionAttemptId(); + + metrics.onStateUpdate(id1, ExecutionState.CREATED, ExecutionState.SCHEDULED); + metrics.onStateUpdate(id2, ExecutionState.CREATED, ExecutionState.SCHEDULED); + + metrics.onStateUpdate(id1, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + metrics.onStateUpdate(id2, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + + metrics.onStateUpdate(id1, ExecutionState.DEPLOYING, ExecutionState.INITIALIZING); + assertThat(metrics.getBinary()).isEqualTo(1L); + } + + @Test + void testOneInitializingAndOneDeploying_streaming() { + final SubStateTimeMetrics metrics = + new SubStateTimeMetrics( + JobType.STREAMING, settings, ExecutionState.INITIALIZING, "initialising"); + + final ExecutionAttemptID id1 = createExecutionAttemptId(); + final ExecutionAttemptID id2 = createExecutionAttemptId(); + + metrics.onStateUpdate(id1, ExecutionState.CREATED, ExecutionState.SCHEDULED); + metrics.onStateUpdate(id2, ExecutionState.CREATED, ExecutionState.SCHEDULED); + + metrics.onStateUpdate(id1, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + metrics.onStateUpdate(id2, ExecutionState.SCHEDULED, ExecutionState.DEPLOYING); + + metrics.onStateUpdate(id1, ExecutionState.DEPLOYING, ExecutionState.INITIALIZING); + assertThat(metrics.getBinary()).isEqualTo(0L); + + metrics.onStateUpdate(id2, ExecutionState.DEPLOYING, ExecutionState.INITIALIZING); + assertThat(metrics.getBinary()).isEqualTo(1L); + } + + @Test + void testInitialzingEnd_streaming_ignoresTerminalDeployments() { Review Comment: I think the test is the only place where we test specific transitions for each supported metric -- and this is the only place that will hold the specifics for future metrics that we add. The reason as to why this test is valuable is because it allows us to check metric level correctness, and also exercises the entire chain (SubStateTimeMetrics, MetricsProvider). The duplication is because the state transitions and expected values for the given metrics are different. Unless you have a strong objection to this, I would rather retain this test. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
