com.rubensousa.carioca.report.runtime.TestReport.kt Maven / Gradle / Ivy
/*
* Copyright 2024 Rúben Sousa
*
* 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.rubensousa.carioca.report.runtime
/**
* Decorates the test reports with extra information
*/
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class TestReport(
/**
* A persistent identifier for a test. Used to track progress of different executions
* Passing empty won't have effect
*/
val id: String = "",
/**
* A human-readable title of the test
*/
val title: String = "",
/**
* A human-readable description of the test
*/
val description: String = "",
/**
* A collection of links relevant for the report
*/
val links: Array = [],
)