Examples with DocumentationWriter org.apache.nifi.documentation.DocumentationWriter used on opensource projects

Example 6 with DocumentationWriter

use of org.apache.nifi.documentation.DocumentationWriter in project nifi by apache.

the class ProcessorDocumentationWriterTest method testNakedProcessor.

@Test
public void testNakedProcessor() throws IOException {
    NakedProcessor processor = new NakedProcessor();
    ProcessorInitializer initializer = new ProcessorInitializer();
    initializer.initialize(processor);
    DocumentationWriter writer = new HtmlProcessorDocumentationWriter();
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    writer.write(processor, baos, false);
    initializer.teardown(processor);
    String results = new String(baos.toByteArray());
    XmlValidator.assertXmlValid(results);
    // no description
    assertContains(results, "No description provided.");
    // no tags
    assertContains(results, "No tags provided.");
    // properties
    assertContains(results, "This component has no required or optional properties.");
    // relationships
    assertContains(results, "This processor has no relationships.");
    // state management
    assertContains(results, "This component does not store state.");
    // state management
    assertContains(results, "This component is not restricted.");
    // input requirement
    assertNotContains(results, "Input requirement:");
}

Example 7 with DocumentationWriter

use of org.apache.nifi.documentation.DocumentationWriter in project nifi by apache.

the class ProcessorDocumentationWriterTest method testDeprecatedProcessor.

@Test
public void testDeprecatedProcessor() throws IOException {
    DeprecatedProcessor processor = new DeprecatedProcessor();
    ProcessorInitializer initializer = new ProcessorInitializer();
    initializer.initialize(processor);
    DocumentationWriter writer = new HtmlProcessorDocumentationWriter();
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    writer.write(processor, baos, false);
    initializer.teardown(processor);
    String results = new String(baos.toByteArray());
    XmlValidator.assertXmlValid(results);
    assertContains(results, DeprecatedProcessor.DIRECTORY.getDisplayName());
    assertContains(results, DeprecatedProcessor.DIRECTORY.getDescription());
    assertContains(results, DeprecatedProcessor.OPTIONAL_PROPERTY.getDisplayName());
    assertContains(results, DeprecatedProcessor.OPTIONAL_PROPERTY.getDescription());
    assertContains(results, DeprecatedProcessor.POLLING_INTERVAL.getDisplayName());
    assertContains(results, DeprecatedProcessor.POLLING_INTERVAL.getDescription());
    assertContains(results, DeprecatedProcessor.POLLING_INTERVAL.getDefaultValue());
    assertContains(results, DeprecatedProcessor.RECURSE.getDisplayName());
    assertContains(results, DeprecatedProcessor.RECURSE.getDescription());
    assertContains(results, DeprecatedProcessor.REL_SUCCESS.getName());
    assertContains(results, DeprecatedProcessor.REL_SUCCESS.getDescription());
    assertContains(results, DeprecatedProcessor.REL_FAILURE.getName());
    assertContains(results, DeprecatedProcessor.REL_FAILURE.getDescription());
    assertContains(results, "Controller Service API: ");
    assertContains(results, "SampleService");
    assertContains(results, "CLUSTER, LOCAL");
    assertContains(results, "state management description");
    assertContains(results, "processor restriction description");
    assertNotContains(results, "iconSecure.png");
    assertContains(results, DeprecatedProcessor.class.getAnnotation(CapabilityDescription.class).value());
    // Check for the existence of deprecation notice
    assertContains(results, "Deprecation notice: ");
    // assertContains(results, DeprecatedProcessor.class.getAnnotation(DeprecationNotice.class.));
    assertNotContains(results, "This component has no required or optional properties.");
    assertNotContains(results, "No description provided.");
    assertNotContains(results, "No tags provided.");
    assertNotContains(results, "Additional Details...");
    // verify the right OnRemoved and OnShutdown methods were called
    Assert.assertEquals(0, processor.getOnRemovedArgs());
    Assert.assertEquals(0, processor.getOnRemovedNoArgs());
    Assert.assertEquals(1, processor.getOnShutdownArgs());
    Assert.assertEquals(1, processor.getOnShutdownNoArgs());
}

Example 8 with DocumentationWriter

use of org.apache.nifi.documentation.DocumentationWriter in project nifi by apache.

the class HtmlDocumentationWriterTest method testControllerServiceWithLogger.

@Test
public void testControllerServiceWithLogger() throws InitializationException, IOException {
    ControllerService controllerService = new ControllerServiceWithLogger();
    controllerService.initialize(new MockControllerServiceInitializationContext());
    DocumentationWriter writer = new HtmlDocumentationWriter();
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    writer.write(controllerService, baos, false);
    String results = new String(baos.toByteArray());
    XmlValidator.assertXmlValid(results);
}