From d62487160a72aeca07978d73a4b3a193ab64082d Mon Sep 17 00:00:00 2001 From: Dmitry Baev Date: Wed, 27 May 2026 16:32:15 +0100 Subject: [PATCH] add javadoc for public api methods --- .../qameta/allure/assertj/AllureAspectJ.java | 44 +- .../assertj/AssertJLifecycleListener.java | 6 + .../allure/assertj/AllureAspectJTest.java | 4 - .../allure/attachment/AttachmentContent.java | 19 +- .../allure/attachment/AttachmentData.java | 6 +- .../attachment/AttachmentProcessor.java | 7 +- .../attachment/AttachmentRenderException.java | 10 +- .../allure/attachment/AttachmentRenderer.java | 1 - .../attachment/DefaultAttachmentContent.java | 20 +- .../DefaultAttachmentProcessor.java | 15 +- .../FreemarkerAttachmentRenderer.java | 12 +- .../http/HttpRequestAttachment.java | 124 ++++- .../http/HttpResponseAttachment.java | 100 ++++- .../DefaultAttachmentProcessorTest.java | 4 - .../FreemarkerAttachmentRendererTest.java | 4 - ...ativeFreemarkerAttachmentRendererTest.java | 4 - .../allure/attachment/testdata/TestData.java | 4 - .../awaitility/AllureAwaitilityListener.java | 6 +- .../allure/awaitility/TemporalDuration.java | 9 + .../io/qameta/allure/citrus/AllureCitrus.java | 59 ++- .../allure/citrus/AllureCitrusTest.java | 4 - .../formatter/TestSourcesModelProxy.java | 33 +- .../cucumber4jvm/AllureCucumber4Jvm.java | 15 +- .../cucumber4jvm/AllureCucumber4JvmTest.java | 4 - .../cucumber4jvm/samples/AmbigiousSteps.java | 4 - .../samples/BackgroundFeatureSteps.java | 4 - .../samples/BrokenFeatureSteps.java | 4 - .../samples/DatatableFeatureSteps.java | 4 - .../cucumber4jvm/samples/HookSteps.java | 4 - .../cucumber4jvm/samples/PendingSteps.java | 4 - .../cucumber4jvm/samples/RuntimeApiSteps.java | 4 - .../samples/SimpleFeatureSteps.java | 4 - .../cucumber5jvm/AllureCucumber5Jvm.java | 15 +- .../testsourcemodel/TestSourcesModel.java | 30 ++ .../TestSourcesModelProxy.java | 34 ++ .../cucumber5jvm/AllureCucumber5JvmTest.java | 4 - .../cucumber5jvm/samples/AmbigiousSteps.java | 4 - .../samples/BackgroundFeatureSteps.java | 4 - .../samples/BrokenFeatureSteps.java | 4 - .../samples/DatatableFeatureSteps.java | 4 - .../cucumber5jvm/samples/HookSteps.java | 4 - .../cucumber5jvm/samples/PendingSteps.java | 4 - .../cucumber5jvm/samples/RuntimeApiSteps.java | 4 - .../samples/SimpleFeatureSteps.java | 4 - .../cucumber6jvm/AllureCucumber6Jvm.java | 15 +- .../TestSourcesModelProxy.java | 34 ++ .../cucumber6jvm/AllureCucumber6JvmTest.java | 4 - .../cucumber6jvm/samples/AmbigiousSteps.java | 4 - .../samples/BackgroundFeatureSteps.java | 4 - .../samples/BrokenFeatureSteps.java | 4 - .../samples/DatatableFeatureSteps.java | 4 - .../cucumber6jvm/samples/HookSteps.java | 4 - .../cucumber6jvm/samples/PendingSteps.java | 4 - .../cucumber6jvm/samples/RuntimeApiSteps.java | 4 - .../samples/SimpleFeatureSteps.java | 4 - .../cucumber7jvm/AllureCucumber7Jvm.java | 15 +- .../TestSourcesModelProxy.java | 34 ++ .../cucumber7jvm/AllureCucumber7JvmTest.java | 4 - .../cucumber7jvm/samples/AmbigiousSteps.java | 4 - .../samples/BackgroundFeatureSteps.java | 4 - .../samples/BrokenFeatureSteps.java | 4 - .../samples/DatatableFeatureSteps.java | 4 - .../cucumber7jvm/samples/HookSteps.java | 4 - .../cucumber7jvm/samples/PendingSteps.java | 4 - .../cucumber7jvm/samples/RuntimeApiSteps.java | 4 - .../samples/SimpleFeatureSteps.java | 4 - .../qameta/allure/description/ClassNames.java | 4 - .../JavaDocDescriptionsProcessor.java | 13 +- .../JavaDocDescriptionRendererTest.java | 1 - .../description/ProcessDescriptionsTest.java | 5 - .../io/qameta/allure/grpc/AllureGrpc.java | 19 +- .../allure/grpc/GrpcRequestAttachment.java | 25 ++ .../allure/grpc/GrpcResponseAttachment.java | 31 ++ .../allure/hamcrest/AllureHamcrestAssert.java | 18 +- .../httpclient/AllureHttpClientRequest.java | 16 +- .../httpclient/AllureHttpClientResponse.java | 16 +- .../httpclient/AllureHttpClientTest.java | 4 - .../httpclient5/AllureHttpClient5Request.java | 18 +- .../AllureHttpClient5Response.java | 18 +- .../AllureHttpClient5DeleteTest.java | 4 - .../httpclient5/AllureHttpClient5GetTest.java | 4 - .../AllureHttpClient5PostTest.java | 4 - .../io/qameta/allure/test/AllureFeatures.java | 4 +- .../qameta/allure/test/AllurePredicates.java | 17 +- .../io/qameta/allure/test/AllureResults.java | 19 +- .../allure/test/AllureResultsWriterStub.java | 22 +- .../allure/test/AllureTestCommonsUtils.java | 4 +- .../java/io/qameta/allure/test/RunUtils.java | 60 ++- .../java/io/qameta/allure/test/TestData.java | 20 +- .../test/ThreadLocalEnhancedRandom.java | 9 +- .../main/java/io/qameta/allure/Allure.java | 69 +++ .../io/qameta/allure/AllureConstants.java | 23 +- .../main/java/io/qameta/allure/AllureId.java | 5 + .../allure/AllureResultsWriteException.java | 10 +- .../io/qameta/allure/AllureResultsWriter.java | 11 +- .../src/main/java/io/qameta/allure/Epic.java | 5 + .../src/main/java/io/qameta/allure/Epics.java | 5 + .../main/java/io/qameta/allure/Feature.java | 5 + .../main/java/io/qameta/allure/Features.java | 5 + .../allure/FileSystemResultsWriter.java | 47 +- .../src/main/java/io/qameta/allure/Issue.java | 5 + .../main/java/io/qameta/allure/Issues.java | 5 + .../io/qameta/allure/LabelAnnotations.java | 5 + .../src/main/java/io/qameta/allure/Lead.java | 5 + .../io/qameta/allure/LinkAnnotations.java | 5 + .../src/main/java/io/qameta/allure/Links.java | 5 + .../src/main/java/io/qameta/allure/Owner.java | 5 + .../main/java/io/qameta/allure/Severity.java | 5 + .../java/io/qameta/allure/SeverityLevel.java | 12 +- .../src/main/java/io/qameta/allure/Step.java | 5 + .../main/java/io/qameta/allure/Stories.java | 5 + .../src/main/java/io/qameta/allure/Story.java | 5 + .../main/java/io/qameta/allure/TmsLink.java | 5 + .../main/java/io/qameta/allure/TmsLinks.java | 5 + .../allure/aspects/AttachmentsAspects.java | 14 +- .../qameta/allure/aspects/StepsAspects.java | 31 +- .../allure/internal/Allure2ModelJackson.java | 9 +- .../qameta/allure/internal/AllureStorage.java | 43 ++ .../allure/internal/AllureThreadContext.java | 1 - .../allure/listener/LifecycleListener.java | 1 - .../qameta/allure/util/AnnotationUtils.java | 1 - .../io/qameta/allure/util/AspectUtils.java | 24 +- .../io/qameta/allure/util/ExceptionUtils.java | 11 +- .../io/qameta/allure/util/NamingUtils.java | 11 +- .../io/qameta/allure/util/ObjectUtils.java | 17 +- .../io/qameta/allure/util/ParameterUtils.java | 11 +- .../qameta/allure/util/PropertiesUtils.java | 5 + .../io/qameta/allure/util/ResultsUtils.java | 425 +++++++++++++++++- .../io/qameta/allure/AllureLifecycleTest.java | 4 - .../java/io/qameta/allure/AllureTest.java | 4 - .../allure/FileSystemResultsWriterTest.java | 4 - .../io/qameta/allure/ResultsUtilsTest.java | 4 - .../allure/StepLifecycleListenerTest.java | 4 - .../allure/aspects/StepsAspectsTest.java | 4 - .../internal/AllureThreadContextTest.java | 4 - .../io/qameta/allure/testdata/DummyCard.java | 4 - .../io/qameta/allure/testdata/DummyEmail.java | 4 - .../io/qameta/allure/testdata/DummyUser.java | 4 - .../allure/util/AnnotationUtilsTest.java | 4 - .../qameta/allure/util/NamingUtilsTest.java | 4 - .../qameta/allure/util/ObjectUtilsTest.java | 4 - .../io/qameta/allure/jaxrs/AllureJaxRs.java | 16 + .../allure/httpclient/AllureJaxRsTest.java | 4 - .../qameta/allure/jbehave/AllureJbehave.java | 78 +++- .../allure/jbehave/AllureJbehaveTest.java | 4 - .../allure/jbehave/LoggingReporter.java | 4 - .../jbehave/samples/BrokenStorySteps.java | 4 - .../jbehave/samples/SimpleStorySteps.java | 4 - .../allure/jbehave5/AllureJbehave5.java | 79 ++++ .../io/qameta/allure/jooq/AllureJooq.java | 27 +- .../io/qameta/allure/jooq/AllureJooqTest.java | 4 - .../jsonunit/AbstractJsonPatchMatcher.java | 73 +++ .../AllureConfigurableJsonMatcher.java | 44 ++ .../allure/jsonunit/DiffAttachment.java | 12 +- .../io/qameta/allure/jsonunit/DiffModel.java | 22 + .../allure/jsonunit/JsonPatchListener.java | 23 + .../junitplatform/AllureJunitPlatform.java | 91 +++- .../AllureJunitPlatformUtils.java | 4 - .../AllurePostDiscoveryFilter.java | 15 +- .../AllureJunitPlatformTest.java | 4 - .../AllureJunitPlatformTestUtils.java | 4 - .../AllurePostDiscoveryFilterTest.java | 4 - .../ActualExpectedStatusDetailsTests.java | 4 - .../features/AllureIdAnnotationSupport.java | 4 - .../junitplatform/features/BrokenTests.java | 4 - .../features/DescriptionJavadocTest.java | 4 - .../features/DisabledRepeatedTests.java | 4 - .../features/DisplayNameOnClassTests.java | 4 - .../junitplatform/features/DynamicTests.java | 4 - .../junitplatform/features/FailedTests.java | 4 - .../features/FilterParameterizedTests.java | 4 - .../features/FilterSimpleTests.java | 4 - .../features/JupiterUniqueIdTest.java | 4 - .../features/MarkerAnnotationSupport.java | 4 - .../junitplatform/features/NestedTests.java | 4 - .../junitplatform/features/OneTest.java | 4 - .../junitplatform/features/OwnerTest.java | 4 - .../junitplatform/features/ParallelTests.java | 4 - .../features/ParameterisedTests.java | 4 - .../ParameterisedTestsWithDisplayName.java | 4 - .../junitplatform/features/PassedTests.java | 4 - .../junitplatform/features/RepeatedTests.java | 4 - .../features/ReportEntryParameter.java | 4 - .../junitplatform/features/SeverityTest.java | 4 - .../junitplatform/features/SkippedTests.java | 4 - .../junitplatform/features/TaggedTests.java | 4 - .../features/TestClassDisabled.java | 4 - .../TestClassWithDisplayNameAnnotation.java | 4 - ...TestClassWithoutDisplayNameAnnotation.java | 4 - .../features/TestWithClassLabels.java | 4 - .../features/TestWithDescription.java | 4 - .../features/TestWithDisplayName.java | 4 - .../features/TestWithMethodLabels.java | 4 - .../junitplatform/features/TestWithSteps.java | 4 - .../features/TestWithSystemErr.java | 4 - .../features/TestWithSystemOut.java | 4 - .../features/TestsWithAllureId.java | 4 - .../aspect/AllureJunit4FilterAspect.java | 10 +- .../aspect/AllureJunit4ListenerAspect.java | 9 +- .../io/qameta/allure/junit4/AllureJunit4.java | 34 ++ .../allure/junit4/AllureJunit4Filter.java | 18 +- .../allure/junit4/AllureJunit4Utils.java | 4 - .../io/qameta/allure/junit4/DisplayName.java | 5 + .../java/io/qameta/allure/junit4/Tag.java | 9 +- .../java/io/qameta/allure/junit4/Tags.java | 9 +- .../test/java/SampleTestInDefaultPackage.java | 4 - .../ActualExpectedStatusDetailsTest.java | 4 - .../junit4/samples/AssumptionFailedTest.java | 4 - .../allure/junit4/samples/BrokenTest.java | 4 - .../samples/BrokenWithoutMessageTest.java | 4 - .../junit4/samples/DescriptionsJavadoc.java | 4 - .../allure/junit4/samples/FailedTest.java | 4 - .../junit4/samples/FilterSimpleTests.java | 4 - .../junit4/samples/IgnoredClassTest.java | 4 - .../allure/junit4/samples/IgnoredTests.java | 4 - .../qameta/allure/junit4/samples/OneTest.java | 4 - .../allure/junit4/samples/TaggedTests.java | 4 - .../junit4/samples/TestWithAnnotations.java | 4 - .../allure/junit4/samples/TestWithSteps.java | 4 - .../allure/junit4/samples/TheoriesTest.java | 4 - .../junit5assert/AllureJunit5Assert.java | 1 - .../jupiterassert/AllureJupiterAssert.java | 29 +- .../junit5assert/AllureJunit5AssertTest.java | 4 - .../io/qameta/allure/junit5/AllureJunit5.java | 1 - .../qameta/allure/jupiter/AllureJupiter.java | 57 ++- .../allure/junit5/AllureJunit5Test.java | 4 - .../ActualExpectedStatusDetailsTests.java | 4 - .../AfterEachFixtureBrokenSupport.java | 4 - .../junit5/features/AllFixtureSupport.java | 4 - .../BeforeAllFixtureFailureSupport.java | 4 - .../BeforeEachFixtureBrokenSupport.java | 4 - .../junit5/features/EachFixtureSupport.java | 4 - ...ParameterisedBlankParameterValueTests.java | 4 - .../ParameterisedPrimitivesTests.java | 4 - .../junit5/features/ParameterisedTests.java | 4 - .../junit5/features/SkipOtherInjectables.java | 4 - .../io/qameta/allure/karate/AllureKarate.java | 27 +- .../allure/karate/AllureKarateTest.java | 4 - .../io/qameta/allure/model/Attachment.java | 1 - .../qameta/allure/model/AttachmentType.java | 37 ++ .../qameta/allure/model/ExecutableItem.java | 1 - .../io/qameta/allure/model/FixtureResult.java | 1 - .../java/io/qameta/allure/model/Label.java | 1 - .../java/io/qameta/allure/model/Link.java | 1 - .../io/qameta/allure/model/Parameter.java | 2 - .../java/io/qameta/allure/model/Stage.java | 5 +- .../java/io/qameta/allure/model/Status.java | 4 +- .../io/qameta/allure/model/StatusDetails.java | 1 - .../io/qameta/allure/model/StepResult.java | 1 - .../io/qameta/allure/model/TestResult.java | 1 - .../allure/model/TestResultContainer.java | 1 - .../qameta/allure/model/WithAttachments.java | 1 - .../io/qameta/allure/model/WithLinks.java | 1 - .../qameta/allure/model/WithParameters.java | 1 - .../io/qameta/allure/model/WithStatus.java | 1 - .../allure/model/WithStatusDetails.java | 1 - .../io/qameta/allure/model/WithSteps.java | 1 - .../io/qameta/allure/okhttp/AllureOkHttp.java | 15 + .../allure/okhttp/AllureOkHttp3Test.java | 4 - .../qameta/allure/okhttp3/AllureOkHttp3.java | 15 + .../allure/okhttp3/AllureOkHttp3Test.java | 4 - .../playwright/AllurePlaywrightAspect.java | 53 +++ .../playwright/AllurePlaywrightLifecycle.java | 6 + .../allure/reader/AllureEnumDeserializer.java | 1 - .../reader/AllureObjectMapperFactory.java | 9 +- .../reader/ParameterModeDeserializer.java | 5 +- .../allure/reader/StageDeserializer.java | 5 +- .../allure/reader/StatusDeserializer.java | 5 +- .../allure/restassured/AllureRestAssured.java | 36 ++ .../restassured/AllureRestAssuredTest.java | 4 - .../allure/scalatest/AllureScalatest.scala | 5 - .../scalatest/AllureScalatestTest.scala | 5 - .../scalatest/testdata/AllureApiSpec.scala | 5 - .../testdata/AnnotationsOnClassSpec.scala | 5 - .../scalatest/testdata/BrokenSpec.scala | 5 - .../scalatest/testdata/CancelledSpec.scala | 5 - .../scalatest/testdata/FailedSpec.scala | 5 - .../scalatest/testdata/IgnoredSpec.scala | 5 - .../scalatest/testdata/SeveritySpec.scala | 5 - .../scalatest/testdata/SimpleSpec.scala | 5 - .../allure/selenide/AllureSelenide.java | 49 +- .../io/qameta/allure/selenide/LogType.java | 6 +- .../allure/selenide/AllureSelenideTest.java | 4 - .../seleniumbidi/AllureWebDriverBiDi.java | 54 +++ .../HttpServletAttachmentBuilder.java | 29 +- .../io/qameta/allure/spock/AllureSpock.java | 35 +- .../qameta/allure/spock/AllureSpockTest.java | 4 - .../allure/spock/samples/BrokenTest.groovy | 4 - .../spock/samples/DataDrivenTest.groovy | 4 - .../allure/spock/samples/FailedTest.groovy | 4 - .../allure/spock/samples/JiraIssue.groovy | 4 - .../allure/spock/samples/OneTest.groovy | 4 - .../spock/samples/ParametersTest.groovy | 4 - .../spock/samples/TestWithAnnotations.groovy | 4 - .../samples/TestWithAnnotationsOnClass.groovy | 4 - .../samples/TestWithCustomAnnotations.groovy | 4 - .../allure/spock/samples/TestWithSteps.groovy | 4 - .../qameta/allure/spock/samples/XrayId.groovy | 4 - .../io/qameta/allure/spock2/AllureSpock2.java | 35 +- ...StatementsLabelsToStepsTransformation.java | 7 +- .../allure/spock2/AllureSpock2Test.java | 4 - .../ActualExpectedStatusDetailsTest.groovy | 4 - .../allure/spock2/samples/BrokenTest.groovy | 4 - .../spock2/samples/DataDrivenTest.groovy | 4 - .../allure/spock2/samples/FailedTest.groovy | 4 - .../allure/spock2/samples/FixturesTest.groovy | 4 - .../allure/spock2/samples/JiraIssue.groovy | 4 - .../allure/spock2/samples/OneTest.groovy | 4 - .../spock2/samples/ParametersTest.groovy | 4 - .../allure/spock2/samples/SpecFixtures.groovy | 4 - .../allure/spock2/samples/SpockTags.groovy | 4 - .../spock2/samples/StepsAndBlocks.groovy | 5 - .../spock2/samples/TestWithAnnotations.groovy | 4 - .../samples/TestWithAnnotationsOnClass.groovy | 4 - .../samples/TestWithCustomAnnotations.groovy | 4 - .../spock2/samples/TestWithSteps.groovy | 4 - .../allure/spock2/samples/XrayId.groovy | 4 - .../allure/springweb/AllureRestTemplate.java | 46 ++ .../springweb/AllureRestTemplateTest.java | 4 - .../testfilter/FileTestPlanSupplier.java | 1 - .../io/qameta/allure/testfilter/TestPlan.java | 4 +- .../allure/testfilter/TestPlanSupplier.java | 1 - .../allure/testfilter/TestPlanUnknown.java | 4 +- .../allure/testfilter/TestPlanV1_0.java | 4 +- .../io/qameta/allure/testng/AllureTestNg.java | 8 +- .../allure/testng/AllureTestNgTestFilter.java | 35 ++ .../java/io/qameta/allure/testng/Tag.java | 9 +- .../java/io/qameta/allure/testng/Tags.java | 9 +- .../testng/config/AllureTestNgConfig.java | 44 ++ .../allure/testng/AllureTestNgTest.java | 4 - .../samples/AfterFixturesCombination.java | 4 - .../allure/testng/samples/AllFeatures.java | 4 - .../testng/samples/AttachmentsTest.java | 4 - .../allure/testng/samples/BaseTest.java | 4 - .../allure/testng/samples/BaseTestA.java | 4 - .../allure/testng/samples/BaseTestB.java | 4 - .../testng/samples/BddAnnotationsTests.java | 4 - .../samples/BddAnnotationsTestsInherited.java | 4 - .../samples/BeforeFixturesCombination.java | 4 - .../allure/testng/samples/BeforeMethods.java | 4 - .../allure/testng/samples/ClassFixtures1.java | 4 - .../allure/testng/samples/ClassFixtures2.java | 4 - .../allure/testng/samples/ClassFixtures3.java | 4 - .../testng/samples/ClassFixturesInParent.java | 4 - .../samples/ClassFixturesInherited.java | 4 - .../testng/samples/ConfigurationFailure.java | 4 - .../testng/samples/CyrillicDescriptions.java | 4 - .../testng/samples/DataProviderWithArray.java | 4 - .../samples/DescriptionsAnotherTest.java | 4 - .../testng/samples/DescriptionsTest.java | 4 - .../allure/testng/samples/DisabledTest.java | 4 - .../samples/FactoryOnConstructorTests.java | 4 - .../testng/samples/FailedAfterMethod.java | 4 - .../testng/samples/FailedAfterSuite.java | 4 - .../testng/samples/FailedAfterTest.java | 4 - .../testng/samples/FailedBeforeClass.java | 4 - .../testng/samples/FailedBeforeMethod.java | 4 - .../testng/samples/FailedBeforeSuite.java | 4 - .../testng/samples/FailedBeforeTest.java | 4 - .../testng/samples/FailedFlakyTest.java | 4 - .../allure/testng/samples/FailedSetUp.java | 4 - .../FailedTestPassedBeforeFixture.java | 4 - .../samples/FixtureWithDescription.java | 4 - .../allure/testng/samples/FlakyMethods.java | 4 - .../testng/samples/FlakyMethodsInherited.java | 4 - .../allure/testng/samples/FlakyTestClass.java | 4 - .../samples/FlakyTestClassInherited.java | 4 - .../HistoryIdForTestWithDataProvider.java | 4 - .../allure/testng/samples/JustTest.java | 4 - .../allure/testng/samples/LinksOnTests.java | 4 - .../testng/samples/LinksOnTestsInherited.java | 4 - .../allure/testng/samples/MutedMethods.java | 4 - .../testng/samples/MutedMethodsInherited.java | 4 - .../allure/testng/samples/MutedTestClass.java | 4 - .../samples/MutedTestClassInherited.java | 4 - .../allure/testng/samples/NestedSteps.java | 4 - .../allure/testng/samples/NullParamTest.java | 4 - .../allure/testng/samples/OwnerClassTest.java | 4 - .../samples/OwnerClassTestInherited.java | 4 - .../testng/samples/OwnerMethodTest.java | 4 - .../samples/OwnerMethodTestInherited.java | 4 - .../testng/samples/ParallelMethods.java | 4 - .../testng/samples/ParameterizedTest.java | 4 - .../testng/samples/PerMethodFixtures.java | 4 - .../testng/samples/PerSuiteFixtures.java | 4 - .../testng/samples/PerTestFixtures.java | 4 - .../allure/testng/samples/RetryTest.java | 4 - .../testng/samples/SeverityClassTest.java | 4 - .../samples/SeverityClassTestInherited.java | 4 - .../testng/samples/SeverityMethodTest.java | 4 - .../samples/SeverityMethodTestInherited.java | 4 - .../allure/testng/samples/SkippedSuite.java | 4 - .../testng/samples/SuiteParameterTest.java | 3 - .../allure/testng/samples/TagClassTest.java | 4 - .../allure/testng/samples/TagMethodTest.java | 4 - .../testng/samples/TestTagFixtures.java | 4 - .../testng/samples/TestWithParameters.java | 4 - .../allure/testng/samples/TestsWithSteps.java | 4 - .../testng/samples/VarargsParameters.java | 4 - 399 files changed, 3024 insertions(+), 1124 deletions(-) diff --git a/allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java b/allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java index 7ba05d2f..33e2a3de 100644 --- a/allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java +++ b/allure-assertj/src/main/java/io/qameta/allure/assertj/AllureAspectJ.java @@ -33,8 +33,6 @@ * Captures user-side AssertJ factories and fluent calls, then delegates assertion-chain state * to {@link AssertJRecorder}. * - * @author charlie (Dmitry Baev). - * @author sskorol (Sergey Korol). */ @SuppressWarnings("all") @Aspect @@ -59,6 +57,10 @@ protected AllureLifecycle initialValue() { + " || call(public * org.assertj.core.api.*SoftAssertionsProvider+.then*(..))" + ")" ) + + /** + * Handles the assert factory call callback. + */ public void assertFactoryCall() { //pointcut body, should be empty } @@ -71,10 +73,19 @@ public void assertFactoryCall() { + ")" + " && target(assertion)" ) + + /** + * Handles the assert operation call callback. + * + * @param assertion the assertion + */ public void assertOperationCall(final AbstractAssert assertion) { //pointcut body, should be empty } + /** + * Handles the user code call callback. + */ @Pointcut("!within(org.assertj..*) && !within(io.qameta.allure.assertj.AllureAspectJ)") public void userCodeCall() { //pointcut body, should be empty @@ -84,6 +95,13 @@ public void userCodeCall() { pointcut = "assertFactoryCall() && userCodeCall()", returning = "result" ) + + /** + * Handles the log assert creation callback. + * + * @param joinPoint the join point + * @param result the model object or framework result to process + */ public void logAssertCreation(final JoinPoint joinPoint, final Object result) { if (isRecordingMuted() || !(result instanceof AbstractAssert)) { return; @@ -93,6 +111,14 @@ public void logAssertCreation(final JoinPoint joinPoint, final Object result) { getRecorder().assertionCreated(getLifecycle(), assertion, firstArgumentOf(joinPoint)); } + /** + * Returns the log assert operation. + * + * @param joinPoint the join point + * @param assertion the assertion + * @return the log assert operation + * @throws Throwable if the underlying framework operation fails + */ @Around("assertOperationCall(assertion) && userCodeCall()") public Object logAssertOperation(final ProceedingJoinPoint joinPoint, final AbstractAssert assertion) @@ -122,6 +148,12 @@ public Object logAssertOperation(final ProceedingJoinPoint joinPoint, "execution(public void org.assertj.core.api.DefaultAssertionErrorCollector.collectAssertionError(" + "java.lang.AssertionError)) && args(error)" ) + + /** + * Handles the soft assertion failed callback. + * + * @param error the error reported by the framework + */ public void softAssertionFailed(final AssertionError error) { getRecorder().softAssertionFailed(error); } @@ -136,10 +168,18 @@ public static void setLifecycle(final AllureLifecycle allure) { clearContext(); } + /** + * Returns the lifecycle. + * + * @return the Allure lifecycle used by this integration + */ public static AllureLifecycle getLifecycle() { return lifecycle.get(); } + /** + * Handles the clear context callback. + */ public static void clearContext() { RECORDER.remove(); } diff --git a/allure-assertj/src/main/java/io/qameta/allure/assertj/AssertJLifecycleListener.java b/allure-assertj/src/main/java/io/qameta/allure/assertj/AssertJLifecycleListener.java index c9ea7a1e..d85316e2 100644 --- a/allure-assertj/src/main/java/io/qameta/allure/assertj/AssertJLifecycleListener.java +++ b/allure-assertj/src/main/java/io/qameta/allure/assertj/AssertJLifecycleListener.java @@ -32,11 +32,17 @@ */ public class AssertJLifecycleListener implements TestLifecycleListener, FixtureLifecycleListener { + /** + * {@inheritDoc} + */ @Override public void afterTestWrite(final TestResult result) { AllureAspectJ.clearContext(); } + /** + * {@inheritDoc} + */ @Override public void afterFixtureStop(final FixtureResult result) { AllureAspectJ.clearContext(); diff --git a/allure-assertj/src/test/java/io/qameta/allure/assertj/AllureAspectJTest.java b/allure-assertj/src/test/java/io/qameta/allure/assertj/AllureAspectJTest.java index 71e14e7c..6013efb8 100644 --- a/allure-assertj/src/test/java/io/qameta/allure/assertj/AllureAspectJTest.java +++ b/allure-assertj/src/test/java/io/qameta/allure/assertj/AllureAspectJTest.java @@ -36,10 +36,6 @@ import static io.qameta.allure.test.RunUtils.runWithinTestContext; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.tuple; - -/** - * @author charlie (Dmitry Baev). - */ class AllureAspectJTest { @AllureFeatures.Steps diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentContent.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentContent.java index 070f2b5c..f3c57536 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentContent.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentContent.java @@ -16,14 +16,31 @@ package io.qameta.allure.attachment; /** - * @author charlie (Dmitry Baev). + * Defines the attachment content contract used by Allure attachment support. + * + *

Implement this interface when custom code needs to participate in the same integration flow as the built-in Allure adapter components.

*/ public interface AttachmentContent { + /** + * Returns the content. + * + * @return the content + */ String getContent(); + /** + * Returns the content type. + * + * @return the content type + */ String getContentType(); + /** + * Returns the file extension. + * + * @return the file extension + */ String getFileExtension(); } diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentData.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentData.java index f7f6af5f..77d8befe 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentData.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentData.java @@ -18,11 +18,15 @@ /** * Marker interface for complex Allure attachments. * - * @author charlie (Dmitry Baev). */ @FunctionalInterface public interface AttachmentData { + /** + * Returns the name. + * + * @return the attachment or display name + */ String getName(); } diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentProcessor.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentProcessor.java index 06ef35fc..2bfbb211 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentProcessor.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentProcessor.java @@ -17,11 +17,16 @@ /** * @param the type of attachment data. - * @author charlie (Dmitry Baev). */ @FunctionalInterface public interface AttachmentProcessor { + /** + * Adds the attachment. + * + * @param attachmentData the attachment data + * @param renderer the renderer used to turn attachment data into content + */ void addAttachment(T attachmentData, AttachmentRenderer renderer); } diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderException.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderException.java index 3a6303e7..b097a0e1 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderException.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderException.java @@ -16,10 +16,18 @@ package io.qameta.allure.attachment; /** - * @author charlie (Dmitry Baev). + * Supports Allure attachment integration with Allure reporting. + * + *

Use this type through the module that owns it when translating framework execution, result metadata, or attachments into Allure report data.

*/ public class AttachmentRenderException extends RuntimeException { + /** + * Creates an attachment render exception with the supplied values. + * + * @param message the message + * @param cause the failure cause reported by the framework + */ public AttachmentRenderException(final String message, final Throwable cause) { super(message, cause); } diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderer.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderer.java index 44029cc8..ea2cee7d 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderer.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/AttachmentRenderer.java @@ -17,7 +17,6 @@ /** * @param the type of attachment data - * @author charlie (Dmitry Baev). */ @FunctionalInterface public interface AttachmentRenderer { diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentContent.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentContent.java index 2e3f200d..fb70c14f 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentContent.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentContent.java @@ -16,7 +16,9 @@ package io.qameta.allure.attachment; /** - * @author charlie (Dmitry Baev). + * Supports Allure attachment integration with Allure reporting. + * + *

Use this type through the module that owns it when translating framework execution, result metadata, or attachments into Allure report data.

*/ public class DefaultAttachmentContent implements AttachmentContent { @@ -26,6 +28,13 @@ public class DefaultAttachmentContent implements AttachmentContent { private final String fileExtension; + /** + * Creates a default attachment content with the supplied values. + * + * @param content the attachment content + * @param contentType the attachment content type + * @param fileExtension the attachment file extension + */ public DefaultAttachmentContent(final String content, final String contentType, final String fileExtension) { @@ -34,16 +43,25 @@ public DefaultAttachmentContent(final String content, this.fileExtension = fileExtension; } + /** + * {@inheritDoc} + */ @Override public String getContent() { return content; } + /** + * {@inheritDoc} + */ @Override public String getContentType() { return contentType; } + /** + * {@inheritDoc} + */ @Override public String getFileExtension() { return fileExtension; diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentProcessor.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentProcessor.java index 017d1f61..3bfc71a4 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentProcessor.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/DefaultAttachmentProcessor.java @@ -21,20 +21,33 @@ import java.nio.charset.StandardCharsets; /** - * @author charlie (Dmitry Baev). + * Supports Allure attachment integration with Allure reporting. + * + *

Use this type through the module that owns it when translating framework execution, result metadata, or attachments into Allure report data.

*/ public class DefaultAttachmentProcessor implements AttachmentProcessor { private final AllureLifecycle lifecycle; + /** + * Creates a default attachment processor with default configuration. + */ public DefaultAttachmentProcessor() { this(Allure.getLifecycle()); } + /** + * Creates a default attachment processor with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + */ public DefaultAttachmentProcessor(final AllureLifecycle lifecycle) { this.lifecycle = lifecycle; } + /** + * {@inheritDoc} + */ @Override public void addAttachment(final AttachmentData attachmentData, final AttachmentRenderer renderer) { diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/FreemarkerAttachmentRenderer.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/FreemarkerAttachmentRenderer.java index 354956d8..6442cb62 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/FreemarkerAttachmentRenderer.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/FreemarkerAttachmentRenderer.java @@ -26,7 +26,9 @@ import java.util.Collections; /** - * @author charlie (Dmitry Baev). + * Supports Allure attachment integration with Allure reporting. + * + *

Use this type through the module that owns it when translating framework execution, result metadata, or attachments into Allure report data.

*/ public class FreemarkerAttachmentRenderer implements AttachmentRenderer { @@ -36,6 +38,11 @@ public class FreemarkerAttachmentRenderer implements AttachmentRendererUse this model to carry request metadata and body content from client interceptors to attachment renderers and processors.

*/ public class HttpRequestAttachment implements AttachmentData { @@ -44,12 +46,35 @@ public class HttpRequestAttachment implements AttachmentData { private final Map formParams; + /** + * Creates an HTTP request attachment with the supplied values. + * + * @param name the display name or logical name to use + * @param url the request URL or service method name + * @param method the framework or Java method to inspect + * @param body the attachment body + * @param curl the curl + * @param headers the headers + * @param cookies the cookies + */ public HttpRequestAttachment(final String name, final String url, final String method, final String body, final String curl, final Map headers, final Map cookies) { this(name, url, method, body, curl, headers, cookies, Collections.emptyMap()); } + /** + * Creates an HTTP request attachment with the supplied values. + * + * @param name the display name or logical name to use + * @param url the request URL or service method name + * @param method the framework or Java method to inspect + * @param body the attachment body + * @param curl the curl + * @param headers the headers + * @param cookies the cookies + * @param formParams the form params + */ @SuppressWarnings("checkstyle:parameternumber") public HttpRequestAttachment(final String name, final String url, final String method, final String body, final String curl, final Map headers, @@ -64,39 +89,80 @@ public HttpRequestAttachment(final String name, final String url, final String m this.formParams = formParams; } + /** + * Returns the url. + * + * @return the url + */ public String getUrl() { return url; } + /** + * Returns the method. + * + * @return the method + */ public String getMethod() { return method; } + /** + * Returns the body. + * + * @return the body + */ public String getBody() { return body; } + /** + * Returns the headers. + * + * @return the headers + */ public Map getHeaders() { return headers; } + /** + * Returns the cookies. + * + * @return the cookies + */ public Map getCookies() { return cookies; } + /** + * Returns the form params. + * + * @return the form params + */ public Map getFormParams() { return formParams; } + /** + * Returns the curl. + * + * @return the curl + */ public String getCurl() { return curl; } + /** + * {@inheritDoc} + */ @Override public String getName() { return name; } + /** + * {@inheritDoc} + */ @Override public String toString() { return "HttpRequestAttachment(" @@ -135,16 +201,36 @@ private Builder(final String name, final String url) { this.url = url; } + /** + * Creates a builder for a builder. + * + * @param attachmentName the attachment display name + * @param url the request URL or service method name + * @return a new builder instance + */ public static Builder create(final String attachmentName, final String url) { return new Builder(attachmentName, url); } + /** + * Sets the method. + * + * @param method the framework or Java method to inspect + * @return this instance for method chaining + */ public Builder setMethod(final String method) { Objects.requireNonNull(method, "Method must not be null value"); this.method = method; return this; } + /** + * Sets the header. + * + * @param name the display name or logical name to use + * @param value the value to set + * @return this instance for method chaining + */ public Builder setHeader(final String name, final String value) { Objects.requireNonNull(name, "Header name must not be null value"); Objects.requireNonNull(value, "Header value must not be null value"); @@ -152,12 +238,25 @@ public Builder setHeader(final String name, final String value) { return this; } + /** + * Sets the headers. + * + * @param headers the headers + * @return this instance for method chaining + */ public Builder setHeaders(final Map headers) { Objects.requireNonNull(headers, "Headers must not be null value"); this.headers.putAll(headers); return this; } + /** + * Sets the cookie. + * + * @param name the display name or logical name to use + * @param value the value to set + * @return this instance for method chaining + */ public Builder setCookie(final String name, final String value) { Objects.requireNonNull(name, "Cookie name must not be null value"); Objects.requireNonNull(value, "Cookie value must not be null value"); @@ -165,18 +264,36 @@ public Builder setCookie(final String name, final String value) { return this; } + /** + * Sets the cookies. + * + * @param cookies the cookies + * @return this instance for method chaining + */ public Builder setCookies(final Map cookies) { Objects.requireNonNull(cookies, "Cookies must not be null value"); this.cookies.putAll(cookies); return this; } + /** + * Sets the body. + * + * @param body the attachment body + * @return this instance for method chaining + */ public Builder setBody(final String body) { Objects.requireNonNull(body, "Body should not be null value"); this.body = body; return this; } + /** + * Sets the form params. + * + * @param formParams the form params + * @return this instance for method chaining + */ public Builder setFormParams(final Map formParams) { Objects.requireNonNull(formParams, "Form params must not be null value"); this.formParams.putAll(formParams); @@ -237,6 +354,11 @@ public Builder withBody(final String body) { return setBody(body); } + /** + * Builds a builder from the configured values. + * + * @return the built attachment model + */ public HttpRequestAttachment build() { return new HttpRequestAttachment(name, url, method, body, getCurl(), headers, cookies, formParams); } diff --git a/allure-attachments/src/main/java/io/qameta/allure/attachment/http/HttpResponseAttachment.java b/allure-attachments/src/main/java/io/qameta/allure/attachment/http/HttpResponseAttachment.java index 20187c7c..4a956dba 100644 --- a/allure-attachments/src/main/java/io/qameta/allure/attachment/http/HttpResponseAttachment.java +++ b/allure-attachments/src/main/java/io/qameta/allure/attachment/http/HttpResponseAttachment.java @@ -23,7 +23,9 @@ import java.util.Objects; /** - * @author charlie (Dmitry Baev). + * Describes an HTTP or RPC response attachment rendered in an Allure report. + * + *

Use this model to carry response metadata and body content from client interceptors to attachment renderers and processors.

*/ public class HttpResponseAttachment implements AttachmentData { @@ -39,6 +41,16 @@ public class HttpResponseAttachment implements AttachmentData { private final Map cookies; + /** + * Creates an HTTP response attachment with the supplied values. + * + * @param name the display name or logical name to use + * @param url the request URL or service method name + * @param body the attachment body + * @param responseCode the response code + * @param headers the headers + * @param cookies the cookies + */ public HttpResponseAttachment(final String name, final String url, final String body, final int responseCode, final Map headers, final Map cookies) { @@ -50,31 +62,62 @@ public HttpResponseAttachment(final String name, final String url, this.cookies = cookies; } + /** + * {@inheritDoc} + */ @Override public String getName() { return name; } + /** + * Returns the url. + * + * @return the url + */ public String getUrl() { return url; } + /** + * Returns the body. + * + * @return the body + */ public String getBody() { return body; } + /** + * Returns the response code. + * + * @return the response code + */ public int getResponseCode() { return responseCode; } + /** + * Returns the headers. + * + * @return the headers + */ public Map getHeaders() { return headers; } + /** + * Returns the cookies. + * + * @return the cookies + */ public Map getCookies() { return cookies; } + /** + * {@inheritDoc} + */ @Override public String toString() { return "HttpResponseAttachment(" @@ -109,21 +152,46 @@ private Builder(final String name) { this.name = name; } + /** + * Creates a builder for a builder. + * + * @param attachmentName the attachment display name + * @return a new builder instance + */ public static Builder create(final String attachmentName) { return new Builder(attachmentName); } + /** + * Sets the url. + * + * @param url the request URL or service method name + * @return this instance for method chaining + */ public Builder setUrl(final String url) { Objects.requireNonNull(url, "Url must not be null value"); this.url = url; return this; } + /** + * Sets the response code. + * + * @param responseCode the response code + * @return this instance for method chaining + */ public Builder setResponseCode(final int responseCode) { this.responseCode = responseCode; return this; } + /** + * Sets the header. + * + * @param name the display name or logical name to use + * @param value the value to set + * @return this instance for method chaining + */ public Builder setHeader(final String name, final String value) { Objects.requireNonNull(name, "Header name must not be null value"); Objects.requireNonNull(value, "Header value must not be null value"); @@ -131,12 +199,25 @@ public Builder setHeader(final String name, final String value) { return this; } + /** + * Sets the headers. + * + * @param headers the headers + * @return this instance for method chaining + */ public Builder setHeaders(final Map headers) { Objects.requireNonNull(headers, "Headers must not be null value"); this.headers.putAll(headers); return this; } + /** + * Sets the cookie. + * + * @param name the display name or logical name to use + * @param value the value to set + * @return this instance for method chaining + */ public Builder setCookie(final String name, final String value) { Objects.requireNonNull(name, "Cookie name must not be null value"); Objects.requireNonNull(value, "Cookie value must not be null value"); @@ -144,12 +225,24 @@ public Builder setCookie(final String name, final String value) { return this; } + /** + * Sets the cookies. + * + * @param cookies the cookies + * @return this instance for method chaining + */ public Builder setCookies(final Map cookies) { Objects.requireNonNull(cookies, "Cookies must not be null value"); this.cookies.putAll(cookies); return this; } + /** + * Sets the body. + * + * @param body the attachment body + * @return this instance for method chaining + */ public Builder setBody(final String body) { Objects.requireNonNull(body, "Body should not be null value"); this.body = body; @@ -226,6 +319,11 @@ public Builder withBody(final String body) { return setBody(body); } + /** + * Builds a builder from the configured values. + * + * @return the built attachment model + */ public HttpResponseAttachment build() { return new HttpResponseAttachment(name, url, body, responseCode, headers, cookies); } diff --git a/allure-attachments/src/test/java/io/qameta/allure/attachment/DefaultAttachmentProcessorTest.java b/allure-attachments/src/test/java/io/qameta/allure/attachment/DefaultAttachmentProcessorTest.java index fe84d9cf..f1defa78 100644 --- a/allure-attachments/src/test/java/io/qameta/allure/attachment/DefaultAttachmentProcessorTest.java +++ b/allure-attachments/src/test/java/io/qameta/allure/attachment/DefaultAttachmentProcessorTest.java @@ -29,10 +29,6 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; - -/** - * @author charlie (Dmitry Baev). - */ class DefaultAttachmentProcessorTest { @SuppressWarnings("unchecked") diff --git a/allure-attachments/src/test/java/io/qameta/allure/attachment/FreemarkerAttachmentRendererTest.java b/allure-attachments/src/test/java/io/qameta/allure/attachment/FreemarkerAttachmentRendererTest.java index 3c37c53a..956080c3 100644 --- a/allure-attachments/src/test/java/io/qameta/allure/attachment/FreemarkerAttachmentRendererTest.java +++ b/allure-attachments/src/test/java/io/qameta/allure/attachment/FreemarkerAttachmentRendererTest.java @@ -23,10 +23,6 @@ import static io.qameta.allure.attachment.testdata.TestData.randomHttpRequestAttachment; import static io.qameta.allure.attachment.testdata.TestData.randomHttpResponseAttachment; import static org.assertj.core.api.Assertions.assertThat; - -/** - * @author charlie (Dmitry Baev). - */ class FreemarkerAttachmentRendererTest { private static final String CONTENT = "content"; diff --git a/allure-attachments/src/test/java/io/qameta/allure/attachment/NegativeFreemarkerAttachmentRendererTest.java b/allure-attachments/src/test/java/io/qameta/allure/attachment/NegativeFreemarkerAttachmentRendererTest.java index 444e5c61..5f5ba6d4 100644 --- a/allure-attachments/src/test/java/io/qameta/allure/attachment/NegativeFreemarkerAttachmentRendererTest.java +++ b/allure-attachments/src/test/java/io/qameta/allure/attachment/NegativeFreemarkerAttachmentRendererTest.java @@ -29,10 +29,6 @@ import static io.qameta.allure.attachment.testdata.TestData.negativeHttpRequestAttachment; import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.assertThrows; - -/** - * @author a-simeshin (Simeshin Artem). - */ class NegativeFreemarkerAttachmentRendererTest { private static final String TEMPLATE_FOR_EXCEPTION = "body-npe-non-safe-attachment.ftl"; diff --git a/allure-attachments/src/test/java/io/qameta/allure/attachment/testdata/TestData.java b/allure-attachments/src/test/java/io/qameta/allure/attachment/testdata/TestData.java index d30634da..3ef9c4c6 100644 --- a/allure-attachments/src/test/java/io/qameta/allure/attachment/testdata/TestData.java +++ b/allure-attachments/src/test/java/io/qameta/allure/attachment/testdata/TestData.java @@ -24,10 +24,6 @@ import java.util.HashMap; import java.util.Map; import java.util.concurrent.ThreadLocalRandom; - -/** - * @author charlie (Dmitry Baev). - */ public final class TestData { private TestData() { diff --git a/allure-awaitility/src/main/java/io/qameta/allure/awaitility/AllureAwaitilityListener.java b/allure-awaitility/src/main/java/io/qameta/allure/awaitility/AllureAwaitilityListener.java index a19e5e31..5cd3b273 100644 --- a/allure-awaitility/src/main/java/io/qameta/allure/awaitility/AllureAwaitilityListener.java +++ b/allure-awaitility/src/main/java/io/qameta/allure/awaitility/AllureAwaitilityListener.java @@ -58,7 +58,6 @@ * *

* - * @author a-simeshin (Simeshin Artem) * @see org.awaitility.core.ConditionEvaluationListener * @see Awaitility#setDefaultConditionEvaluationListener(ConditionEvaluationListener) * @see ConditionFactory#conditionEvaluationListener(ConditionEvaluationListener) @@ -84,6 +83,11 @@ protected AllureLifecycle initialValue() { } }; + /** + * Returns the lifecycle. + * + * @return the Allure lifecycle used by this integration + */ public static AllureLifecycle getLifecycle() { return LIFECYCLE.get(); } diff --git a/allure-awaitility/src/main/java/io/qameta/allure/awaitility/TemporalDuration.java b/allure-awaitility/src/main/java/io/qameta/allure/awaitility/TemporalDuration.java index 5632b1be..d6243f7f 100644 --- a/allure-awaitility/src/main/java/io/qameta/allure/awaitility/TemporalDuration.java +++ b/allure-awaitility/src/main/java/io/qameta/allure/awaitility/TemporalDuration.java @@ -58,11 +58,17 @@ public class TemporalDuration implements TemporalAccessor { this.temporal = duration.addTo(BASE); } + /** + * {@inheritDoc} + */ @Override public boolean isSupported(final TemporalField field) { return temporal.isSupported(field) && temporal.getLong(field) - BASE.getLong(field) != 0L; } + /** + * {@inheritDoc} + */ @Override public long getLong(final TemporalField temporalField) { if (!isSupported(temporalField)) { @@ -71,6 +77,9 @@ public long getLong(final TemporalField temporalField) { return temporal.getLong(temporalField) - BASE.getLong(temporalField); } + /** + * {@inheritDoc} + */ @Override public String toString() { if (duration.compareTo(Duration.ofMillis(1)) < 0) { diff --git a/allure-citrus/src/main/java/io/qameta/allure/citrus/AllureCitrus.java b/allure-citrus/src/main/java/io/qameta/allure/citrus/AllureCitrus.java index b50ec45d..cc5e669d 100644 --- a/allure-citrus/src/main/java/io/qameta/allure/citrus/AllureCitrus.java +++ b/allure-citrus/src/main/java/io/qameta/allure/citrus/AllureCitrus.java @@ -63,7 +63,9 @@ import static io.qameta.allure.util.ResultsUtils.getProvidedLabels; /** - * @author charlie (Dmitry Baev). + * Reports Citrus test execution to Allure. + * + *

Register this listener with Citrus so suite, test case, and test action events are reflected as Allure containers, fixtures, tests, and steps. The listener can use the global lifecycle or an explicitly provided lifecycle.

*/ public class AllureCitrus implements TestListener, TestSuiteListener, TestActionListener { @@ -73,64 +75,107 @@ public class AllureCitrus implements TestListener, TestSuiteListener, TestAction private final AllureLifecycle lifecycle; + /** + * Creates an Allure citrus with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + */ public AllureCitrus(final AllureLifecycle lifecycle) { this.lifecycle = lifecycle; } + /** + * Creates an Allure citrus with default configuration. + */ @SuppressWarnings("unused") public AllureCitrus() { this.lifecycle = Allure.getLifecycle(); } + /** + * Returns the lifecycle. + * + * @return the Allure lifecycle used by this integration + */ public AllureLifecycle getLifecycle() { return lifecycle; } + /** + * {@inheritDoc} + */ @Override public void onStart() { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onStartSuccess() { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onStartFailure(final Throwable cause) { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onFinish() { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onFinishSuccess() { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onFinishFailure(final Throwable cause) { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onTestStart(final TestCase test) { startTestCase(test); } + /** + * {@inheritDoc} + */ @Override public void onTestFinish(final TestCase test) { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onTestSuccess(final TestCase test) { stopTestCase(test, Status.PASSED, null); } + /** + * {@inheritDoc} + */ @Override public void onTestFailure(final TestCase test, final Throwable cause) { final Status status = ResultsUtils.getStatus(cause).orElse(Status.BROKEN); @@ -138,11 +183,17 @@ public void onTestFailure(final TestCase test, final Throwable cause) { stopTestCase(test, status, details); } + /** + * {@inheritDoc} + */ @Override public void onTestSkipped(final TestCase test) { //do nothing } + /** + * {@inheritDoc} + */ @Override public void onTestActionStart(final TestCase testCase, final TestAction testAction) { final String parentUuid = getUuid(testCase); @@ -150,11 +201,17 @@ public void onTestActionStart(final TestCase testCase, final TestAction testActi getLifecycle().startStep(parentUuid, uuid, new StepResult().setName(testAction.getName())); } + /** + * {@inheritDoc} + */ @Override public void onTestActionFinish(final TestCase testCase, final TestAction testAction) { getLifecycle().stopStep(); } + /** + * {@inheritDoc} + */ @Override public void onTestActionSkipped(final TestCase testCase, final TestAction testAction) { //do nothing diff --git a/allure-citrus/src/test/java/io/qameta/allure/citrus/AllureCitrusTest.java b/allure-citrus/src/test/java/io/qameta/allure/citrus/AllureCitrusTest.java index eb4b05d2..71202f2b 100644 --- a/allure-citrus/src/test/java/io/qameta/allure/citrus/AllureCitrusTest.java +++ b/allure-citrus/src/test/java/io/qameta/allure/citrus/AllureCitrusTest.java @@ -44,10 +44,6 @@ import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.tuple; - -/** - * @author charlie (Dmitry Baev). - */ @SuppressWarnings("unchecked") class AllureCitrusTest { diff --git a/allure-cucumber4-jvm/src/main/java/cucumber/runtime/formatter/TestSourcesModelProxy.java b/allure-cucumber4-jvm/src/main/java/cucumber/runtime/formatter/TestSourcesModelProxy.java index f0209d58..1c19d47b 100644 --- a/allure-cucumber4-jvm/src/main/java/cucumber/runtime/formatter/TestSourcesModelProxy.java +++ b/allure-cucumber4-jvm/src/main/java/cucumber/runtime/formatter/TestSourcesModelProxy.java @@ -20,28 +20,59 @@ import gherkin.ast.ScenarioDefinition; /** - * Proxy class to internal Cucumber implementation of TestSourcesModel. + * Compatibility proxy around Cucumber feature source storage. + * + *

The proxy hides version-specific Cucumber source model APIs from the reporting plugin. Integrations use it to add source-read events and resolve feature, scenario, and step keyword metadata during execution.

*/ public class TestSourcesModelProxy { private final TestSourcesModel testSources; + /** + * Creates a test sources model proxy with default configuration. + */ public TestSourcesModelProxy() { this.testSources = new TestSourcesModel(); } + /** + * Adds the test source read event. + * + * @param path the path to read from or write to + * @param event the framework event to process + */ public void addTestSourceReadEvent(final String path, final TestSourceRead event) { testSources.addTestSourceReadEvent(path, event); } + /** + * Returns the feature. + * + * @param path the path to read from or write to + * @return the feature + */ public Feature getFeature(final String path) { return testSources.getFeature(path); } + /** + * Returns the scenario definition. + * + * @param path the path to read from or write to + * @param line the source line number to resolve + * @return the scenario definition + */ public ScenarioDefinition getScenarioDefinition(final String path, final int line) { return testSources.getScenarioDefinition(path, line); } + /** + * Returns the keyword from source. + * + * @param uri the feature file URI + * @param stepLine the feature file line number of the step + * @return the keyword from source + */ public String getKeywordFromSource(final String uri, final int stepLine) { return testSources.getKeywordFromSource(uri, stepLine); } diff --git a/allure-cucumber4-jvm/src/main/java/io/qameta/allure/cucumber4jvm/AllureCucumber4Jvm.java b/allure-cucumber4-jvm/src/main/java/io/qameta/allure/cucumber4jvm/AllureCucumber4Jvm.java index 7cfdc67e..cc291892 100644 --- a/allure-cucumber4-jvm/src/main/java/io/qameta/allure/cucumber4jvm/AllureCucumber4Jvm.java +++ b/allure-cucumber4-jvm/src/main/java/io/qameta/allure/cucumber4jvm/AllureCucumber4Jvm.java @@ -78,7 +78,9 @@ import static io.qameta.allure.util.ResultsUtils.md5; /** - * Allure plugin for Cucumber JVM 4.0. + * Reports Cucumber JVM 4 execution to Allure. + * + *

Add this plugin to the Cucumber runtime so feature, scenario, step, hook, and attachment events are converted into Allure results. Use the default lifecycle for normal runs or pass one explicitly for embedded runners and tests.

*/ @SuppressWarnings( { @@ -113,15 +115,26 @@ public class AllureCucumber4Jvm implements ConcurrentEventListener { private static final String TEXT_PLAIN = "text/plain"; private static final String CUCUMBER_WORKING_DIR = Paths.get("").toUri().getSchemeSpecificPart(); + /** + * Creates an Allure cucumber4 jvm with default configuration. + */ @SuppressWarnings("unused") public AllureCucumber4Jvm() { this(Allure.getLifecycle()); } + /** + * Creates an Allure cucumber4 jvm with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + */ public AllureCucumber4Jvm(final AllureLifecycle lifecycle) { this.lifecycle = lifecycle; } + /** + * {@inheritDoc} + */ @Override public void setEventPublisher(final EventPublisher publisher) { publisher.registerHandlerFor(TestSourceRead.class, featureStartedHandler); diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/AllureCucumber4JvmTest.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/AllureCucumber4JvmTest.java index 640148a1..dc6b6bb0 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/AllureCucumber4JvmTest.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/AllureCucumber4JvmTest.java @@ -62,10 +62,6 @@ import static org.assertj.core.api.Assertions.tuple; import static org.junit.jupiter.api.parallel.ResourceAccessMode.READ_WRITE; import static org.junit.jupiter.api.parallel.Resources.SYSTEM_PROPERTIES; - -/** - * @author charlie (Dmitry Baev). - */ class AllureCucumber4JvmTest { @AllureFeatures.Base diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/AmbigiousSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/AmbigiousSteps.java index 07de408c..06e9fbee 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/AmbigiousSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/AmbigiousSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class AmbigiousSteps { @When("^ambigious step (.+)$") diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BackgroundFeatureSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BackgroundFeatureSteps.java index 261680d8..9658b4f9 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BackgroundFeatureSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BackgroundFeatureSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.en.Given; import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class BackgroundFeatureSteps { @Given("^cat is sad$") diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BrokenFeatureSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BrokenFeatureSteps.java index 7521a2f4..e10e3cea 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BrokenFeatureSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/BrokenFeatureSteps.java @@ -16,10 +16,6 @@ package io.qameta.allure.cucumber4jvm.samples; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class BrokenFeatureSteps { @Given("^everything is broken$") diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/DatatableFeatureSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/DatatableFeatureSteps.java index 235af032..0861d463 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/DatatableFeatureSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/DatatableFeatureSteps.java @@ -17,10 +17,6 @@ import io.cucumber.datatable.DataTable; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ @SuppressWarnings("unused") public class DatatableFeatureSteps { diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/HookSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/HookSteps.java index 9c4666fa..2a13ec8e 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/HookSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/HookSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.After; import io.cucumber.java.Before; import org.assertj.core.api.Assertions; - -/** - * @author letsrokk (Dmitry Mayer). - */ public class HookSteps { @Before("@WithHooks") diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/PendingSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/PendingSteps.java index 1ab2b3f7..3fa6e3db 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/PendingSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/PendingSteps.java @@ -17,10 +17,6 @@ import cucumber.api.PendingException; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class PendingSteps { @Given("^step is yet to be implemented$") diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/RuntimeApiSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/RuntimeApiSteps.java index 16ac1320..7ce4af5c 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/RuntimeApiSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/RuntimeApiSteps.java @@ -20,10 +20,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import io.qameta.allure.Allure; - -/** - * @author charlie (Dmitry Baev). - */ public class RuntimeApiSteps { @Before("@beforeScenario") diff --git a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/SimpleFeatureSteps.java b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/SimpleFeatureSteps.java index 0d1f7723..e336b5e6 100644 --- a/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/SimpleFeatureSteps.java +++ b/allure-cucumber4-jvm/src/test/java/io/qameta/allure/cucumber4jvm/samples/SimpleFeatureSteps.java @@ -19,10 +19,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import org.assertj.core.api.Assertions; - -/** - * @author charlie (Dmitry Baev). - */ public class SimpleFeatureSteps { private int a; diff --git a/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/AllureCucumber5Jvm.java b/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/AllureCucumber5Jvm.java index 682cc378..cdcd95bd 100644 --- a/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/AllureCucumber5Jvm.java +++ b/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/AllureCucumber5Jvm.java @@ -74,7 +74,9 @@ import static io.qameta.allure.util.ResultsUtils.md5; /** - * Allure plugin for Cucumber JVM 5.0. + * Reports Cucumber JVM 5 execution to Allure. + * + *

Add this plugin to the Cucumber runtime so feature, scenario, step, hook, and attachment events are converted into Allure results. Use the default lifecycle for normal runs or pass one explicitly for embedded runners and tests.

*/ @SuppressWarnings( { @@ -108,15 +110,26 @@ public class AllureCucumber5Jvm implements ConcurrentEventListener { private static final String TEXT_PLAIN = "text/plain"; private static final String CUCUMBER_WORKING_DIR = Paths.get("").toUri().getSchemeSpecificPart(); + /** + * Creates an Allure cucumber5 jvm with default configuration. + */ @SuppressWarnings("unused") public AllureCucumber5Jvm() { this(Allure.getLifecycle()); } + /** + * Creates an Allure cucumber5 jvm with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + */ public AllureCucumber5Jvm(final AllureLifecycle lifecycle) { this.lifecycle = lifecycle; } + /** + * {@inheritDoc} + */ @Override public void setEventPublisher(final EventPublisher publisher) { publisher.registerHandlerFor(TestSourceRead.class, featureStartedHandler); diff --git a/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModel.java b/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModel.java index 7249c97a..4b390e11 100644 --- a/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModel.java +++ b/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModel.java @@ -33,21 +33,44 @@ import java.util.HashMap; import java.util.Map; +/** + * Stores parsed Cucumber feature source information. + * + *

Cucumber integrations use this model to map runtime events back to feature, scenario, and step definitions. It helps build accurate Allure names, labels, and step keywords from source files and line numbers.

+ */ public final class TestSourcesModel { private final Map pathToReadEventMap = new HashMap<>(); private final Map pathToAstMap = new HashMap<>(); private final Map> pathToNodeMap = new HashMap<>(); + /** + * Returns the scenario definition. + * + * @param astNode the Cucumber AST node to inspect + * @return the scenario definition + */ public static ScenarioDefinition getScenarioDefinition(final AstNode astNode) { return astNode.node instanceof ScenarioDefinition ? (ScenarioDefinition) astNode.node : (ScenarioDefinition) astNode.parent.parent.node; } + /** + * Adds the test source read event. + * + * @param path the path to read from or write to + * @param event the framework event to process + */ public void addTestSourceReadEvent(final URI path, final TestSourceRead event) { pathToReadEventMap.put(path, event); } + /** + * Returns the feature. + * + * @param path the path to read from or write to + * @return the feature + */ public Feature getFeature(final URI path) { if (!pathToAstMap.containsKey(path)) { parseGherkinSource(path); @@ -58,6 +81,13 @@ public Feature getFeature(final URI path) { return null; } + /** + * Returns the ast node. + * + * @param path the path to read from or write to + * @param line the source line number to resolve + * @return the ast node + */ public AstNode getAstNode(final URI path, final int line) { if (!pathToNodeMap.containsKey(path)) { parseGherkinSource(path); diff --git a/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModelProxy.java b/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModelProxy.java index 8a1bbe7c..ec7415ee 100644 --- a/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModelProxy.java +++ b/allure-cucumber5-jvm/src/main/java/io/qameta/allure/cucumber5jvm/testsourcemodel/TestSourcesModelProxy.java @@ -25,28 +25,62 @@ import java.util.HashMap; import java.util.Map; +/** + * Compatibility proxy around Cucumber feature source storage. + * + *

The proxy hides version-specific Cucumber source model APIs from the reporting plugin. Integrations use it to add source-read events and resolve feature, scenario, and step keyword metadata during execution.

+ */ public class TestSourcesModelProxy { private final Map pathToReadEventMap = new HashMap<>(); private final TestSourcesModel testSources; + /** + * Creates a test sources model proxy with default configuration. + */ public TestSourcesModelProxy() { this.testSources = new TestSourcesModel(); } + /** + * Adds the test source read event. + * + * @param path the path to read from or write to + * @param event the framework event to process + */ public void addTestSourceReadEvent(final URI path, final TestSourceRead event) { this.pathToReadEventMap.put(path, event); testSources.addTestSourceReadEvent(path, event); } + /** + * Returns the feature. + * + * @param path the path to read from or write to + * @return the feature + */ public Feature getFeature(final URI path) { return testSources.getFeature(path); } + /** + * Returns the scenario definition. + * + * @param path the path to read from or write to + * @param line the source line number to resolve + * @return the scenario definition + */ public ScenarioDefinition getScenarioDefinition(final URI path, final int line) { return testSources.getScenarioDefinition(testSources.getAstNode(path, line)); } + /** + * Returns the keyword from source. + * + * @param uri the feature file URI + * @param stepLine the feature file line number of the step + * @return the keyword from source + */ public String getKeywordFromSource(final URI uri, final int stepLine) { return this.getKeywordFromSourceInternal(uri, stepLine); } diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/AllureCucumber5JvmTest.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/AllureCucumber5JvmTest.java index 11f28271..d70b8741 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/AllureCucumber5JvmTest.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/AllureCucumber5JvmTest.java @@ -65,10 +65,6 @@ import static org.assertj.core.api.Assertions.tuple; import static org.junit.jupiter.api.parallel.ResourceAccessMode.READ_WRITE; import static org.junit.jupiter.api.parallel.Resources.SYSTEM_PROPERTIES; - -/** - * @author charlie (Dmitry Baev). - */ class AllureCucumber5JvmTest { @AllureFeatures.Base diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/AmbigiousSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/AmbigiousSteps.java index fe41e55b..eca7e0f3 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/AmbigiousSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/AmbigiousSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class AmbigiousSteps { @When("^ambigious step (.+)$") diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BackgroundFeatureSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BackgroundFeatureSteps.java index 8a8a75e4..57cd03e2 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BackgroundFeatureSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BackgroundFeatureSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.en.Given; import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class BackgroundFeatureSteps { @Given("^cat is sad$") diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BrokenFeatureSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BrokenFeatureSteps.java index 900968ad..2fde1f09 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BrokenFeatureSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/BrokenFeatureSteps.java @@ -16,10 +16,6 @@ package io.qameta.allure.cucumber5jvm.samples; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class BrokenFeatureSteps { @Given("^everything is broken$") diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/DatatableFeatureSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/DatatableFeatureSteps.java index 98f22865..db70f804 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/DatatableFeatureSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/DatatableFeatureSteps.java @@ -17,10 +17,6 @@ import io.cucumber.datatable.DataTable; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ @SuppressWarnings("unused") public class DatatableFeatureSteps { diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/HookSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/HookSteps.java index 8c7162e7..786c53c2 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/HookSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/HookSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.After; import io.cucumber.java.Before; import org.assertj.core.api.Assertions; - -/** - * @author letsrokk (Dmitry Mayer). - */ public class HookSteps { @Before("@WithHooks") diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/PendingSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/PendingSteps.java index 2b09a1f5..65a521e4 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/PendingSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/PendingSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.PendingException; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class PendingSteps { @Given("^step is yet to be implemented$") diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/RuntimeApiSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/RuntimeApiSteps.java index f507b64a..adc9e2fa 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/RuntimeApiSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/RuntimeApiSteps.java @@ -20,10 +20,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import io.qameta.allure.Allure; - -/** - * @author charlie (Dmitry Baev). - */ public class RuntimeApiSteps { @Before("@beforeScenario") diff --git a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/SimpleFeatureSteps.java b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/SimpleFeatureSteps.java index 46b0e946..4f489a54 100644 --- a/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/SimpleFeatureSteps.java +++ b/allure-cucumber5-jvm/src/test/java/io/qameta/allure/cucumber5jvm/samples/SimpleFeatureSteps.java @@ -19,10 +19,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import org.assertj.core.api.Assertions; - -/** - * @author charlie (Dmitry Baev). - */ public class SimpleFeatureSteps { private int a; diff --git a/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/AllureCucumber6Jvm.java b/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/AllureCucumber6Jvm.java index c7384b9b..148dfe4c 100644 --- a/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/AllureCucumber6Jvm.java +++ b/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/AllureCucumber6Jvm.java @@ -72,7 +72,9 @@ import static io.qameta.allure.util.ResultsUtils.md5; /** - * Allure plugin for Cucumber JVM 6.0. + * Reports Cucumber JVM 6 execution to Allure. + * + *

Add this plugin to the Cucumber runtime so feature, scenario, step, hook, and attachment events are converted into Allure results. Use the default lifecycle for normal runs or pass one explicitly for embedded runners and tests.

*/ @SuppressWarnings( { @@ -103,15 +105,26 @@ public class AllureCucumber6Jvm implements ConcurrentEventListener { private static final String TEXT_PLAIN = "text/plain"; private static final String CUCUMBER_WORKING_DIR = Paths.get("").toUri().getSchemeSpecificPart(); + /** + * Creates an Allure cucumber6 jvm with default configuration. + */ @SuppressWarnings("unused") public AllureCucumber6Jvm() { this(Allure.getLifecycle()); } + /** + * Creates an Allure cucumber6 jvm with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + */ public AllureCucumber6Jvm(final AllureLifecycle lifecycle) { this.lifecycle = lifecycle; } + /** + * {@inheritDoc} + */ @Override public void setEventPublisher(final EventPublisher publisher) { publisher.registerHandlerFor(TestSourceRead.class, featureStartedHandler); diff --git a/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/testsourcemodel/TestSourcesModelProxy.java b/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/testsourcemodel/TestSourcesModelProxy.java index 36096f18..2e88546c 100644 --- a/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/testsourcemodel/TestSourcesModelProxy.java +++ b/allure-cucumber6-jvm/src/main/java/io/qameta/allure/cucumber6jvm/testsourcemodel/TestSourcesModelProxy.java @@ -25,28 +25,62 @@ import java.util.HashMap; import java.util.Map; +/** + * Compatibility proxy around Cucumber feature source storage. + * + *

The proxy hides version-specific Cucumber source model APIs from the reporting plugin. Integrations use it to add source-read events and resolve feature, scenario, and step keyword metadata during execution.

+ */ public class TestSourcesModelProxy { private final Map pathToReadEventMap = new HashMap<>(); private final TestSourcesModel testSources; + /** + * Creates a test sources model proxy with default configuration. + */ public TestSourcesModelProxy() { this.testSources = new TestSourcesModel(); } + /** + * Adds the test source read event. + * + * @param path the path to read from or write to + * @param event the framework event to process + */ public void addTestSourceReadEvent(final URI path, final TestSourceRead event) { this.pathToReadEventMap.put(path, event); testSources.addTestSourceReadEvent(path, event); } + /** + * Returns the feature. + * + * @param path the path to read from or write to + * @return the feature + */ public Feature getFeature(final URI path) { return testSources.getFeature(path); } + /** + * Returns the scenario definition. + * + * @param path the path to read from or write to + * @param line the source line number to resolve + * @return the scenario definition + */ public Scenario getScenarioDefinition(final URI path, final int line) { return TestSourcesModel.getScenarioDefinition(testSources.getAstNode(path, line)); } + /** + * Returns the keyword from source. + * + * @param uri the feature file URI + * @param stepLine the feature file line number of the step + * @return the keyword from source + */ public String getKeywordFromSource(final URI uri, final int stepLine) { return this.getKeywordFromSourceInternal(uri, stepLine); } diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/AllureCucumber6JvmTest.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/AllureCucumber6JvmTest.java index 6788dc6c..3cb35169 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/AllureCucumber6JvmTest.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/AllureCucumber6JvmTest.java @@ -65,10 +65,6 @@ import static org.assertj.core.api.Assertions.tuple; import static org.junit.jupiter.api.parallel.ResourceAccessMode.READ_WRITE; import static org.junit.jupiter.api.parallel.Resources.SYSTEM_PROPERTIES; - -/** - * @author charlie (Dmitry Baev). - */ class AllureCucumber6JvmTest { @AllureFeatures.Base diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/AmbigiousSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/AmbigiousSteps.java index 22a70c07..3ea3058c 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/AmbigiousSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/AmbigiousSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class AmbigiousSteps { @When("^ambigious step (.+)$") diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BackgroundFeatureSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BackgroundFeatureSteps.java index 578abfdf..5d909884 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BackgroundFeatureSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BackgroundFeatureSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.en.Given; import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class BackgroundFeatureSteps { @Given("^cat is sad$") diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BrokenFeatureSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BrokenFeatureSteps.java index 1222c28f..b1922783 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BrokenFeatureSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/BrokenFeatureSteps.java @@ -16,10 +16,6 @@ package io.qameta.allure.cucumber6jvm.samples; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class BrokenFeatureSteps { @Given("^everything is broken$") diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/DatatableFeatureSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/DatatableFeatureSteps.java index b8a69f6b..d278ec28 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/DatatableFeatureSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/DatatableFeatureSteps.java @@ -17,10 +17,6 @@ import io.cucumber.datatable.DataTable; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ @SuppressWarnings("unused") public class DatatableFeatureSteps { diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/HookSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/HookSteps.java index 5ca9cc61..94ceb8d7 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/HookSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/HookSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.After; import io.cucumber.java.Before; import org.assertj.core.api.Assertions; - -/** - * @author letsrokk (Dmitry Mayer). - */ public class HookSteps { @Before("@WithHooks") diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/PendingSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/PendingSteps.java index f0a8fb7a..d4d1498c 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/PendingSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/PendingSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.PendingException; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class PendingSteps { @Given("^step is yet to be implemented$") diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/RuntimeApiSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/RuntimeApiSteps.java index 4fd9281d..61010571 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/RuntimeApiSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/RuntimeApiSteps.java @@ -20,10 +20,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import io.qameta.allure.Allure; - -/** - * @author charlie (Dmitry Baev). - */ public class RuntimeApiSteps { @Before("@beforeScenario") diff --git a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/SimpleFeatureSteps.java b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/SimpleFeatureSteps.java index 8d1c005a..e7618526 100644 --- a/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/SimpleFeatureSteps.java +++ b/allure-cucumber6-jvm/src/test/java/io/qameta/allure/cucumber6jvm/samples/SimpleFeatureSteps.java @@ -19,10 +19,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import org.assertj.core.api.Assertions; - -/** - * @author charlie (Dmitry Baev). - */ public class SimpleFeatureSteps { private int a; diff --git a/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java b/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java index ac4ca986..032335b8 100644 --- a/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java +++ b/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/AllureCucumber7Jvm.java @@ -73,7 +73,9 @@ import static io.qameta.allure.util.ResultsUtils.md5; /** - * Allure plugin for Cucumber JVM 7.0. + * Reports Cucumber JVM 7 execution to Allure. + * + *

Add this plugin to the Cucumber runtime so feature, scenario, step, hook, and attachment events are converted into Allure results. Use the default lifecycle for normal runs or pass one explicitly for embedded runners and tests.

*/ @SuppressWarnings( { @@ -104,15 +106,26 @@ public class AllureCucumber7Jvm implements ConcurrentEventListener { private static final String TEXT_PLAIN = "text/plain"; private static final String CUCUMBER_WORKING_DIR = Paths.get("").toUri().getSchemeSpecificPart(); + /** + * Creates an Allure cucumber7 jvm with default configuration. + */ @SuppressWarnings("unused") public AllureCucumber7Jvm() { this(Allure.getLifecycle()); } + /** + * Creates an Allure cucumber7 jvm with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + */ public AllureCucumber7Jvm(final AllureLifecycle lifecycle) { this.lifecycle = lifecycle; } + /** + * {@inheritDoc} + */ @Override public void setEventPublisher(final EventPublisher publisher) { publisher.registerHandlerFor(TestSourceRead.class, featureStartedHandler); diff --git a/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/testsourcemodel/TestSourcesModelProxy.java b/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/testsourcemodel/TestSourcesModelProxy.java index 9a922620..155257b6 100644 --- a/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/testsourcemodel/TestSourcesModelProxy.java +++ b/allure-cucumber7-jvm/src/main/java/io/qameta/allure/cucumber7jvm/testsourcemodel/TestSourcesModelProxy.java @@ -26,28 +26,62 @@ import java.util.Map; import java.util.Objects; +/** + * Compatibility proxy around Cucumber feature source storage. + * + *

The proxy hides version-specific Cucumber source model APIs from the reporting plugin. Integrations use it to add source-read events and resolve feature, scenario, and step keyword metadata during execution.

+ */ public class TestSourcesModelProxy { private final Map pathToReadEventMap = new HashMap<>(); private final TestSourcesModel testSources; + /** + * Creates a test sources model proxy with default configuration. + */ public TestSourcesModelProxy() { this.testSources = new TestSourcesModel(); } + /** + * Adds the test source read event. + * + * @param path the path to read from or write to + * @param event the framework event to process + */ public void addTestSourceReadEvent(final URI path, final TestSourceRead event) { this.pathToReadEventMap.put(path, event); testSources.addTestSourceReadEvent(path, event); } + /** + * Returns the feature. + * + * @param path the path to read from or write to + * @return the feature + */ public Feature getFeature(final URI path) { return testSources.getFeature(path); } + /** + * Returns the scenario definition. + * + * @param path the path to read from or write to + * @param line the source line number to resolve + * @return the scenario definition + */ public Scenario getScenarioDefinition(final URI path, final int line) { return TestSourcesModel.getScenarioDefinition(testSources.getAstNode(path, line)); } + /** + * Returns the keyword from source. + * + * @param uri the feature file URI + * @param stepLine the feature file line number of the step + * @return the keyword from source + */ public String getKeywordFromSource(final URI uri, final int stepLine) { return this.getKeywordFromSourceInternal(uri, stepLine); } diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/AllureCucumber7JvmTest.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/AllureCucumber7JvmTest.java index ea50e510..109de2c4 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/AllureCucumber7JvmTest.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/AllureCucumber7JvmTest.java @@ -65,10 +65,6 @@ import static org.assertj.core.api.Assertions.tuple; import static org.junit.jupiter.api.parallel.ResourceAccessMode.READ_WRITE; import static org.junit.jupiter.api.parallel.Resources.SYSTEM_PROPERTIES; - -/** - * @author charlie (Dmitry Baev). - */ class AllureCucumber7JvmTest { @AllureFeatures.Base diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/AmbigiousSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/AmbigiousSteps.java index b5fec46c..baaeee7a 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/AmbigiousSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/AmbigiousSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class AmbigiousSteps { @When("^ambigious step (.+)$") diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BackgroundFeatureSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BackgroundFeatureSteps.java index 1cb2041c..93f55c03 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BackgroundFeatureSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BackgroundFeatureSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.en.Given; import io.cucumber.java.en.Then; import io.cucumber.java.en.When; - -/** - * @author charlie (Dmitry Baev). - */ public class BackgroundFeatureSteps { @Given("^cat is sad$") diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BrokenFeatureSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BrokenFeatureSteps.java index e2b7676b..3dbcfa76 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BrokenFeatureSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/BrokenFeatureSteps.java @@ -16,10 +16,6 @@ package io.qameta.allure.cucumber7jvm.samples; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class BrokenFeatureSteps { @Given("^everything is broken$") diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/DatatableFeatureSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/DatatableFeatureSteps.java index d43bacfc..d01b6ce7 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/DatatableFeatureSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/DatatableFeatureSteps.java @@ -17,10 +17,6 @@ import io.cucumber.datatable.DataTable; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ @SuppressWarnings("unused") public class DatatableFeatureSteps { diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/HookSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/HookSteps.java index 46ca418a..c20d9dbe 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/HookSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/HookSteps.java @@ -18,10 +18,6 @@ import io.cucumber.java.After; import io.cucumber.java.Before; import org.assertj.core.api.Assertions; - -/** - * @author letsrokk (Dmitry Mayer). - */ public class HookSteps { @Before("@WithHooks") diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/PendingSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/PendingSteps.java index b3c74e1b..bbdc1fce 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/PendingSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/PendingSteps.java @@ -17,10 +17,6 @@ import io.cucumber.java.PendingException; import io.cucumber.java.en.Given; - -/** - * @author charlie (Dmitry Baev). - */ public class PendingSteps { @Given("^step is yet to be implemented$") diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/RuntimeApiSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/RuntimeApiSteps.java index 50eabea7..393f880f 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/RuntimeApiSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/RuntimeApiSteps.java @@ -20,10 +20,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import io.qameta.allure.Allure; - -/** - * @author charlie (Dmitry Baev). - */ public class RuntimeApiSteps { @Before("@beforeScenario") diff --git a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/SimpleFeatureSteps.java b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/SimpleFeatureSteps.java index 1280d9a5..b82ddb3d 100644 --- a/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/SimpleFeatureSteps.java +++ b/allure-cucumber7-jvm/src/test/java/io/qameta/allure/cucumber7jvm/samples/SimpleFeatureSteps.java @@ -19,10 +19,6 @@ import io.cucumber.java.en.Then; import io.cucumber.java.en.When; import org.assertj.core.api.Assertions; - -/** - * @author charlie (Dmitry Baev). - */ public class SimpleFeatureSteps { private int a; diff --git a/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/ClassNames.java b/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/ClassNames.java index 09def58c..b3338a2f 100644 --- a/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/ClassNames.java +++ b/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/ClassNames.java @@ -14,10 +14,6 @@ * limitations under the License. */ package io.qameta.allure.description; - -/** - * @author charlie (Dmitry Baev). - */ final class ClassNames { static final String DESCRIPTION_ANNOTATION = "io.qameta.allure.Description"; diff --git a/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java b/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java index 289c5f43..bd77d395 100644 --- a/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java +++ b/allure-descriptions-javadoc/src/main/java/io/qameta/allure/description/JavaDocDescriptionsProcessor.java @@ -45,7 +45,9 @@ import static io.qameta.allure.description.ClassNames.DESCRIPTION_ANNOTATION; /** - * @author Egor Borisov ehborisov@gmail.com + * Supports allure-descriptions-javadoc integration with Allure reporting. + * + *

Use this type through the module that owns it when translating framework execution, result metadata, or attachments into Allure report data.

*/ @SupportedAnnotationTypes(DESCRIPTION_ANNOTATION) public class JavaDocDescriptionsProcessor extends AbstractProcessor { @@ -57,6 +59,9 @@ public class JavaDocDescriptionsProcessor extends AbstractProcessor { private Messager messager; private JavaDocDescriptionRenderer renderer; + /** + * {@inheritDoc} + */ @Override @SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel") public synchronized void init(final ProcessingEnvironment env) { @@ -67,11 +72,17 @@ public synchronized void init(final ProcessingEnvironment env) { renderer = new JavaDocDescriptionRenderer(); } + /** + * {@inheritDoc} + */ @Override public SourceVersion getSupportedSourceVersion() { return SourceVersion.latest(); } + /** + * {@inheritDoc} + */ @Override public boolean process(final Set annotations, final RoundEnvironment env) { final TypeElement typeElement = elementUtils.getTypeElement(DESCRIPTION_ANNOTATION); diff --git a/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/JavaDocDescriptionRendererTest.java b/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/JavaDocDescriptionRendererTest.java index b82f4c47..7c85dfc5 100644 --- a/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/JavaDocDescriptionRendererTest.java +++ b/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/JavaDocDescriptionRendererTest.java @@ -310,7 +310,6 @@ void shouldRenderComplexModernJavadocExampleSafely() { + "\n" + "Example: client.fetch(\"v2\")\n" + "@beta remains prose.\n" - + "@author Jane Doe\n" + "@version 2.3.0\n" + "@since 2.0" ); diff --git a/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/ProcessDescriptionsTest.java b/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/ProcessDescriptionsTest.java index 49ab0437..f3af3750 100644 --- a/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/ProcessDescriptionsTest.java +++ b/allure-descriptions-javadoc/src/test/java/io/qameta/allure/description/ProcessDescriptionsTest.java @@ -25,10 +25,6 @@ import static com.google.testing.compile.CompilationSubject.assertThat; import static com.google.testing.compile.Compiler.javac; - -/** - * @author Egor Borisov ehborisov@gmail.com - */ class ProcessDescriptionsTest { private static final String ALLURE_DESCRIPTIONS_FOLDER = "META-INF/allureDescriptions/"; @@ -267,7 +263,6 @@ void shouldCaptureComplexModernJavadocDescriptionSafely() { "* Example: client.fetch(\"v2\")", "* @beta remains prose.", "*", - "* @author Jane Doe", "* @version 2.3.0", "* @since 2.0", "* @see Javadoc spec", diff --git a/allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java b/allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java index 73c0fa52..e98953fc 100644 --- a/allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java +++ b/allure-grpc/src/main/java/io/qameta/allure/grpc/AllureGrpc.java @@ -47,9 +47,9 @@ import java.util.UUID; /** - * Allure interceptor logger for gRPC. + * Captures gRPC client calls as Allure attachments. * - * @author dtuchs (Dmitry Tuchs). + *

Attach this interceptor to a gRPC channel or stub to record request messages, response messages, metadata, and call status. The default constructor uses built-in templates; the explicit constructor accepts custom renderers and processors.

*/ @SuppressWarnings( { @@ -72,6 +72,9 @@ public class AllureGrpc implements ClientInterceptor { private final String requestTemplatePath; private final String responseTemplatePath; + /** + * Creates an Allure grpc with default configuration. + */ public AllureGrpc() { this( Allure.getLifecycle(), true, false, @@ -79,6 +82,15 @@ public AllureGrpc() { ); } + /** + * Creates an Allure grpc with the supplied values. + * + * @param lifecycle the Allure lifecycle to use + * @param markStepFailedOnNonZeroCode the mark step failed on non zero code + * @param interceptResponseMetadata the intercept response metadata + * @param requestTemplatePath the request template path + * @param responseTemplatePath the response template path + */ public AllureGrpc( final AllureLifecycle lifecycle, final boolean markStepFailedOnNonZeroCode, @@ -92,6 +104,9 @@ public AllureGrpc( this.responseTemplatePath = responseTemplatePath; } + /** + * {@inheritDoc} + */ @Override public ClientCall interceptCall( final MethodDescriptor methodDescriptor, diff --git a/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcRequestAttachment.java b/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcRequestAttachment.java index 1f227672..37966d02 100644 --- a/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcRequestAttachment.java +++ b/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcRequestAttachment.java @@ -19,26 +19,51 @@ import java.util.Objects; +/** + * Describes an HTTP or RPC request attachment rendered in an Allure report. + * + *

Use this model to carry request metadata and body content from client interceptors to attachment renderers and processors.

+ */ public class GrpcRequestAttachment implements AttachmentData { private final String name; private final String url; private final String body; + /** + * Creates a gRPC request attachment with the supplied values. + * + * @param name the display name or logical name to use + * @param url the request URL or service method name + * @param body the attachment body + */ public GrpcRequestAttachment(final String name, final String url, final String body) { this.name = name; this.url = url; this.body = body; } + /** + * Returns the url. + * + * @return the url + */ public String getUrl() { return url; } + /** + * Returns the body. + * + * @return the body + */ public String getBody() { return body; } + /** + * {@inheritDoc} + */ @Override public String getName() { return name; diff --git a/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcResponseAttachment.java b/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcResponseAttachment.java index 414aa725..04f12518 100644 --- a/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcResponseAttachment.java +++ b/allure-grpc/src/main/java/io/qameta/allure/grpc/GrpcResponseAttachment.java @@ -21,6 +21,11 @@ import java.util.Map; import java.util.Objects; +/** + * Describes an HTTP or RPC response attachment rendered in an Allure report. + * + *

Use this model to carry response metadata and body content from client interceptors to attachment renderers and processors.

+ */ public class GrpcResponseAttachment implements AttachmentData { private final String name; @@ -28,6 +33,14 @@ public class GrpcResponseAttachment implements AttachmentData { private final String status; private final Map metadata; + /** + * Creates a gRPC response attachment with the supplied values. + * + * @param name the display name or logical name to use + * @param body the attachment body + * @param status the response status + * @param metadata the metadata values to include + */ public GrpcResponseAttachment(final String name, final String body, final String status, @@ -38,18 +51,36 @@ public GrpcResponseAttachment(final String name, this.metadata = metadata; } + /** + * Returns the body. + * + * @return the body + */ public String getBody() { return body; } + /** + * Returns the metadata. + * + * @return the metadata + */ public Map getMetadata() { return metadata; } + /** + * Returns the status. + * + * @return the status + */ public String getStatus() { return status; } + /** + * {@inheritDoc} + */ @Override public String getName() { return name; diff --git a/allure-hamcrest/src/main/java/io/qameta/allure/hamcrest/AllureHamcrestAssert.java b/allure-hamcrest/src/main/java/io/qameta/allure/hamcrest/AllureHamcrestAssert.java index 4a1782ed..99d60fd9 100644 --- a/allure-hamcrest/src/main/java/io/qameta/allure/hamcrest/AllureHamcrestAssert.java +++ b/allure-hamcrest/src/main/java/io/qameta/allure/hamcrest/AllureHamcrestAssert.java @@ -47,7 +47,6 @@ * methods in the TypeSafeMatcher class. *

* - * @author a-simeshin (Simeshin Artem) * @see org.hamcrest.TypeSafeMatcher */ @Aspect @@ -61,10 +60,18 @@ protected AllureLifecycle initialValue() { } }; + /** + * Returns the lifecycle. + * + * @return the Allure lifecycle used by this integration + */ public static AllureLifecycle getLifecycle() { return lifecycle.get(); } + /** + * Handles the init assert that callback. + */ @Pointcut("execution(void org.hamcrest.MatcherAssert.**(..))") public void initAssertThat() { } @@ -110,11 +117,20 @@ public void catchAndStartStep(final JoinPoint joinPoint) { pointcut = "initAssertThat()", throwing = "e" ) + + /** + * Handles the step failed callback. + * + * @param e the e + */ public void stepFailed(final Throwable e) { getLifecycle().updateStep(s -> s.setStatus(getStatus(e).orElse(Status.BROKEN))); getLifecycle().stopStep(); } + /** + * Handles the step stop callback. + */ @AfterReturning(pointcut = "initAssertThat()") public void stepStop() { getLifecycle().updateStep(s -> s.setStatus(Status.PASSED)); diff --git a/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientRequest.java b/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientRequest.java index 833f45bc..1530c63a 100644 --- a/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientRequest.java +++ b/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientRequest.java @@ -35,13 +35,18 @@ import static io.qameta.allure.attachment.http.HttpRequestAttachment.Builder.create; /** - * @author charlie (Dmitry Baev). + * Captures Apache HttpClient 4 requests as Allure attachments. + * + *

Register an instance as an {@link org.apache.http.HttpRequestInterceptor} on the client. The default constructor uses the standard request template and writer; the explicit constructor accepts custom rendering and processing components.

*/ public class AllureHttpClientRequest implements HttpRequestInterceptor { private final AttachmentRenderer renderer; private final AttachmentProcessor processor; + /** + * Creates an Allure http client request with default configuration. + */ public AllureHttpClientRequest() { this( new FreemarkerAttachmentRenderer("http-request.ftl"), @@ -49,6 +54,12 @@ public AllureHttpClientRequest() { ); } + /** + * Creates an Allure http client request with the supplied values. + * + * @param renderer the renderer used to turn attachment data into content + * @param processor the processor used to write rendered attachments + */ public AllureHttpClientRequest(final AttachmentRenderer renderer, final AttachmentProcessor processor) { this.renderer = renderer; @@ -62,6 +73,9 @@ private static String getAttachmentName(final HttpRequest request) { ); } + /** + * {@inheritDoc} + */ @Override public void process(final HttpRequest request, final HttpContext context) diff --git a/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java b/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java index 5e8daec1..a1ae607a 100644 --- a/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java +++ b/allure-httpclient/src/main/java/io/qameta/allure/httpclient/AllureHttpClientResponse.java @@ -33,13 +33,18 @@ import static io.qameta.allure.attachment.http.HttpResponseAttachment.Builder.create; /** - * @author charlie (Dmitry Baev). + * Captures Apache HttpClient 4 responses as Allure attachments. + * + *

Register an instance as an {@link org.apache.http.HttpResponseInterceptor} on the client. The default constructor uses the standard response template and writer; the explicit constructor accepts custom rendering and processing components.

*/ public class AllureHttpClientResponse implements HttpResponseInterceptor { private final AttachmentRenderer renderer; private final AttachmentProcessor processor; + /** + * Creates an Allure http client response with default configuration. + */ public AllureHttpClientResponse() { this( new FreemarkerAttachmentRenderer("http-response.ftl"), @@ -47,12 +52,21 @@ public AllureHttpClientResponse() { ); } + /** + * Creates an Allure http client response with the supplied values. + * + * @param renderer the renderer used to turn attachment data into content + * @param processor the processor used to write rendered attachments + */ public AllureHttpClientResponse(final AttachmentRenderer renderer, final AttachmentProcessor processor) { this.renderer = renderer; this.processor = processor; } + /** + * {@inheritDoc} + */ @Override public void process(final HttpResponse response, final HttpContext context) diff --git a/allure-httpclient/src/test/java/io/qameta/allure/httpclient/AllureHttpClientTest.java b/allure-httpclient/src/test/java/io/qameta/allure/httpclient/AllureHttpClientTest.java index 8ed24f1f..36289202 100644 --- a/allure-httpclient/src/test/java/io/qameta/allure/httpclient/AllureHttpClientTest.java +++ b/allure-httpclient/src/test/java/io/qameta/allure/httpclient/AllureHttpClientTest.java @@ -46,10 +46,6 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; - -/** - * @author charlie (Dmitry Baev). - */ class AllureHttpClientTest { private static final String BODY_STRING = "Hello world!"; diff --git a/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Request.java b/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Request.java index 60aff399..75a30ef3 100644 --- a/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Request.java +++ b/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Request.java @@ -32,21 +32,37 @@ import static io.qameta.allure.attachment.http.HttpRequestAttachment.Builder.create; /** - * @author a-simeshin (Simeshin Artem) + * Captures Apache HttpClient 5 requests as Allure attachments. + * + *

Register an instance as an {@link org.apache.hc.core5.http.HttpRequestInterceptor}. The interceptor records request metadata and delegates attachment rendering to the configured Allure components.

*/ public class AllureHttpClient5Request implements HttpRequestInterceptor { private final AttachmentRenderer renderer; private final AttachmentProcessor processor; + /** + * Creates an Allure http client5 request with default configuration. + */ public AllureHttpClient5Request() { this("http-request.ftl"); } + /** + * Creates an Allure http client5 request with the supplied values. + * + * @param templateName the template name + */ public AllureHttpClient5Request(final String templateName) { this(new FreemarkerAttachmentRenderer(templateName), new DefaultAttachmentProcessor()); } + /** + * Creates an Allure http client5 request with the supplied values. + * + * @param renderer the renderer used to turn attachment data into content + * @param processor the processor used to write rendered attachments + */ public AllureHttpClient5Request(final AttachmentRenderer renderer, final AttachmentProcessor processor) { this.renderer = renderer; diff --git a/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Response.java b/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Response.java index 90cdd03a..c2826041 100644 --- a/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Response.java +++ b/allure-httpclient5/src/main/java/io/qameta/allure/httpclient5/AllureHttpClient5Response.java @@ -35,7 +35,9 @@ import static io.qameta.allure.attachment.http.HttpResponseAttachment.Builder.create; /** - * @author a-simeshin (Simeshin Artem) + * Captures Apache HttpClient 5 responses as Allure attachments. + * + *

Register an instance as an {@link org.apache.hc.core5.http.HttpResponseInterceptor}. The interceptor records response metadata and delegates attachment rendering to the configured Allure components.

*/ @SuppressWarnings( { @@ -47,14 +49,28 @@ public class AllureHttpClient5Response implements HttpResponseInterceptor { private final AttachmentProcessor processor; private static final String NO_BODY = "No body present"; + /** + * Creates an Allure http client5 response with default configuration. + */ public AllureHttpClient5Response() { this("http-response.ftl"); } + /** + * Creates an Allure http client5 response with the supplied values. + * + * @param templateName the template name + */ public AllureHttpClient5Response(final String templateName) { this(new FreemarkerAttachmentRenderer(templateName), new DefaultAttachmentProcessor()); } + /** + * Creates an Allure http client5 response with the supplied values. + * + * @param renderer the renderer used to turn attachment data into content + * @param processor the processor used to write rendered attachments + */ public AllureHttpClient5Response(final AttachmentRenderer renderer, final AttachmentProcessor processor) { this.renderer = renderer; diff --git a/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5DeleteTest.java b/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5DeleteTest.java index 89ad99f7..f5de9d23 100644 --- a/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5DeleteTest.java +++ b/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5DeleteTest.java @@ -40,10 +40,6 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; - -/** - * @author a-simeshin (Simeshin Artem). - */ @SuppressWarnings({"unchecked", "PMD.JUnitTestContainsTooManyAsserts"}) class AllureHttpClient5DeleteTest { diff --git a/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5GetTest.java b/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5GetTest.java index 468f2580..4edadc80 100644 --- a/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5GetTest.java +++ b/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5GetTest.java @@ -41,10 +41,6 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; - -/** - * @author a-simeshin (Simeshin Artem). - */ @SuppressWarnings({"unchecked", "PMD.JUnitTestContainsTooManyAsserts"}) class AllureHttpClient5GetTest { diff --git a/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5PostTest.java b/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5PostTest.java index e2a375df..61d43da1 100644 --- a/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5PostTest.java +++ b/allure-httpclient5/src/test/java/io/qameta/allure/httpclient5/AllureHttpClient5PostTest.java @@ -43,10 +43,6 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; - -/** - * @author a-simeshin (Simeshin Artem). - */ @SuppressWarnings({"unchecked", "PMD.JUnitTestContainsTooManyAsserts"}) class AllureHttpClient5PostTest { diff --git a/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllureFeatures.java b/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllureFeatures.java index e3706d29..50e84637 100644 --- a/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllureFeatures.java +++ b/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllureFeatures.java @@ -25,7 +25,9 @@ import java.lang.annotation.Target; /** - * @author charlie (Dmitry Baev). + * Integrates Allure Java test support with Allure reporting. + * + *

Register this type through the standard Allure Java test support extension, listener, interceptor, or plugin mechanism so framework execution events are written to Allure results. Use explicit dependencies when embedding the integration in tests or custom runtimes.

*/ @SuppressWarnings({"JavadocType"}) @Target({}) diff --git a/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllurePredicates.java b/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllurePredicates.java index cfb24b3d..2a5b7b00 100644 --- a/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllurePredicates.java +++ b/allure-java-commons-test/src/main/java/io/qameta/allure/test/AllurePredicates.java @@ -23,7 +23,9 @@ import java.util.function.Predicate; /** - * @author charlie (Dmitry Baev). + * Integrates Allure Java test support with Allure reporting. + * + *

Register this type through the standard Allure Java test support extension, listener, interceptor, or plugin mechanism so framework execution events are written to Allure results. Use explicit dependencies when embedding the integration in tests or custom runtimes.

*/ public final class AllurePredicates { @@ -31,10 +33,23 @@ private AllurePredicates() { throw new IllegalStateException("Do not instance"); } + /** + * Returns whether status is available. + * + * @param status the response status + * @return true when status; false otherwise + */ public static Predicate hasStatus(final Status status) { return testResult -> status.equals(testResult.getStatus()); } + /** + * Returns whether label is available. + * + * @param name the display name or logical name to use + * @param value the value to set + * @return true when label; false otherwise + */ public static Predicate hasLabel(final String name, final String value) { final Predicate