zio.test.junit.ZIOSuiteTestDescriptor.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024-2024 Vincent Raman and the ZIO Contributors
 *
 * 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 zio.test.junit

import org.junit.platform.engine.support.descriptor.AbstractTestDescriptor
import org.junit.platform.engine.{TestDescriptor, UniqueId}

/**
 * Describes a JUnit 5 test descriptor for a suite of ZIO tests.
 *
 * @constructor
 *   Creates an instance of ZIOSuiteTestDescriptor.
 * @param parent
 *   The parent TestDescriptor.
 * @param uniqueId
 *   The unique identifier for this test descriptor.
 * @param label
 *   The display name of this test descriptor.
 * @param testClass
 *   The class representing the suite of tests.
 */
class ZIOSuiteTestDescriptor(
  parent: TestDescriptor,
  uniqueId: UniqueId,
  label: String,
  testClass: Class[_]
) extends AbstractTestDescriptor(uniqueId, label, ZIOTestSource(testClass)) {
  setParent(parent)
  override def getType: TestDescriptor.Type = TestDescriptor.Type.CONTAINER
}

object ZIOSuiteTestDescriptor {
  val segmentType = "suite"
}