How to use the_HTML_Report_Generator_is_executed method of com.tngtech.jgiven.report.html5.WhenHtml5ReportGenerator class

Best JGiven code snippet using com.tngtech.jgiven.report.html5.WhenHtml5ReportGenerator.the_HTML_Report_Generator_is_executed

Source:Html5AppTest.java

...65        given().a_report_model();66        jsonReports67            .and().the_report_exist_as_JSON_file();68        whenReport69            .and().the_HTML_Report_Generator_is_executed();70        when().the_index_page_is_opened();71        then().the_page_title_is("Welcome");72    }73    @Test74    public void the_statistics_on_the_welcome_page_of_the_HTML5_report_is_correct() throws Exception {75        given().a_report_model()76            .and().the_report_has_$_scenarios(3)77            .and().step_$_of_case_$_has_status(1, 1, StepStatus.FAILED);78        jsonReports79            .and().the_report_exist_as_JSON_file();80        whenReport81            .and().the_HTML_Report_Generator_is_executed();82        when().the_index_page_is_opened();83        then().the_page_statistics_line_contains_text("3 Total")84            .and().the_page_statistics_line_contains_text("2 Successful")85            .and().the_page_statistics_line_contains_text("1 Failed")86            .and().the_page_statistics_line_contains_text("0 Pending");87    }88    @Test89    @FeatureTags90    @Issue("#47")91    @DataProvider({92        "true,  testtag-#42",93        "false, #42"})94    public void clicking_on_tag_labels_opens_the_tag_page(boolean prependType, String tagName) throws Exception {95        given().a_report_model()96            .and().scenario_$_has_tag_$_with_value_$(1, "testtag", "#42")97            .and().the_tag_has_prependType_set_to(prependType);98        jsonReports99            .and().the_report_exist_as_JSON_file();100        whenReport101            .and().the_HTML_Report_Generator_is_executed();102        when().the_All_Scenarios_page_is_opened()103            .and().the_tag_with_name_$_is_clicked(tagName);104        then().the_page_title_is(tagName);105    }106    @Test107    @FeatureTagsWithCustomStyle108    public void tags_with_custom_styles_are_shown_correctly() throws Exception {109        String style = "background-color: black;";110        given().a_report_model()111            .and().the_first_scenario_has_tag("TagWithCustomStyle")112            .and().the_tag_has_style(style);113        jsonReports114            .and().the_report_exist_as_JSON_file();115        whenReport116            .and().the_HTML_Report_Generator_is_executed();117        when().the_All_Scenarios_page_is_opened();118        then().the_page_contains_tag("TagWithCustomStyle")119            .and().the_tag_has_style(style);120    }121    @Test122    @Issue("#191")123    @FeatureAttachments124    public void attachments_of_all_cases_appear_in_the_HTML5_report_when_having_a_data_table() throws Exception {125        given().a_report_model()126            .and().the_scenario_has_one_parameter()127            .and().the_scenario_has_$_default_cases(2)128            .and().step_$_of_case_$_has_a_text_attachment(1, 1)129            .and().step_$_of_case_$_has_a_text_attachment(1, 2);130        jsonReports131            .and().the_report_exist_as_JSON_file();132        whenReport133            .and().the_HTML_Report_Generator_is_executed();134        when().the_page_of_scenario_$_is_opened(1);135        then().$_attachment_icons_exist(2);136    }137    @Test138    @FeatureAttachments139    public void attachments_appear_in_the_HTML5_report() throws Exception {140        String content = "Some Example Attachment\nwith some example content";141        given().a_report_model()142            .and().step_$_of_scenario_$_has_a_text_attachment_with_content(1, 1, content);143        jsonReports144            .and().the_report_exist_as_JSON_file();145        whenReport146            .and().the_HTML_Report_Generator_is_executed();147        when().the_page_of_scenario_$_is_opened(1);148        then().an_attachment_icon_exists()149            .and().the_content_of_the_attachment_referenced_by_the_icon_is(content);150    }151    @Test152    @FeatureAttachments153    public void steps_can_have_multiple_attachments() throws Exception {154        String content1 = "Some Example Attachment\nwith some example content";155        String content2 = "Another Example Attachment\nwith some example content";156        given().a_report_model()157            .and().step_$_of_scenario_$_has_a_text_attachment_with_content(1, 1, content1)158            .and().step_$_of_scenario_$_has_another_text_attachment_with_content(1, 1, content2);159        jsonReports160            .and().the_report_exist_as_JSON_file();161        whenReport162            .and().the_HTML_Report_Generator_is_executed();163        when().the_page_of_scenario_$_is_opened(1);164        then().$_attachment_icons_exist(2)165            .and().the_content_of_the_attachment_referenced_by_icon_$_is(1, content1)166            .and().the_content_of_the_attachment_referenced_by_icon_$_is(2, content2);167    }168    @Test169    public void the_configured_title_appears_in_the_generated_HTML_report() throws Exception {170        given().a_report_model();171        jsonReports172            .and().the_report_exist_as_JSON_file();173        whenReport174            .and().the_HTML_Report_Generator_is_executed_with_title("Test Title");175        when().the_index_page_is_opened();176        then().the_report_title_is("Test Title");177    }178    @Issue("#146")179    @Test180    @DataProvider({181        "JGiven Documentation, http://jgiven.org/docs",182        "Back, javascript:window.history.back()"})183    public void navigation_links_of_the_HTML_report_can_be_customized_using_a_custom_JS_file(String title, String href)184        throws Exception {185        given().a_report_model();186        jsonReports187            .and().the_report_exist_as_JSON_file()188            .given().a_custom_JS_file_with_content(189            "jgivenReport.addNavigationLink( { \n"190                + "   href: '" + href + "', \n"191                + "   text: '" + title + "', \n"192                + "   target: '_blank' \n"193                + "});");194        whenReport.when().the_HTML_Report_Generator_is_executed();195        when().and().the_index_page_is_opened();196        then().the_navigation_menu_has_a_link_with_text(title.toUpperCase())197            .and().href(href)198            .and().target("_blank");199    }200    @Test201    @Issue("#226")202    public void newlines_are_detected_in_formatted_values_and_shown_as_multiline_text() throws IOException {203        String content = "Some \n text \n with \n newlines";204        given().a_report_model()205            .and().step_$_of_case_$_has_a_formatted_value_$_as_parameter(1, 1, content);206        jsonReports207            .and().the_report_exist_as_JSON_file();208        whenReport.when().the_HTML_Report_Generator_is_executed();209        when().the_page_of_scenario_$_is_opened(1);210        then().an_element_with_a_$_class_exists("multiline")211            .and().has_content(content);212    }213    @DataProvider214    public static Object[][] parserTestData() {215        return new Object[][] {216            {"Placeholder with index", "$1", Arrays.asList("a", "b"), Arrays.asList(1, 2), "1"},217            {"Placeholder without index", "$", Arrays.asList("a", "b"), Arrays.asList(1, 2), "1"},218            {"Escaped placeholder", "$$", Arrays.asList("a", "b"), Arrays.asList(1, 2), "$"},219            {"Multiple placeholders with switch order", "$2 + $1", Arrays.asList("a", "b"), Arrays.asList(1, 2),220                "2 + 1"},221            {"Placeholders with additional text", "a = $1 and b = $2", Arrays.asList("a", "b"), Arrays.asList(1, 2),222                "a = 1 and b = 2"},223            {"Placeholders references by argument names in order", "int = $int and str = $str and bool = $bool",224                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),225                "int = 1 and str = some string and bool = true"},226            {"Placeholders references by argument names in mixed order", "str = $str and int = $int and bool = $bool",227                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),228                "str = some string and int = 1 and bool = true"},229            {"Placeholders references by argument names and enumeration", "str = $str and int = $1 and bool = $bool",230                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),231                "str = some string and int = 1 and bool = true"},232            {"Placeholders references by argument names and enumerations ", "bool = $3 and str = $2 and int = $int",233                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),234                "bool = true and str = some string and int = 1"},235            {"Placeholder without index mixed with names", "bool = $bool and int = $ and str = $",236                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),237                "bool = true and int = 1 and str = some string"},238            {"Placeholder without index mixed with names and index",239                "bool = $bool and str = $2 and int = $ and str = $ and bool = $3",240                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),241                "bool = true and str = some string and int = 1 and str = some string and bool = true"},242            {"Placeholder with unknown argument names get erased",243                "bool = $bool and not known = $unknown and unknown = $10",244                Arrays.asList("int", "str", "bool"), Arrays.asList(1, "some string", true),245                "bool = true and not known = 1 and unknown = some string"},246            {"Non-Java-Identifier char does trigger a space after a placeholder", "$]",247                Collections.singletonList("int"), Collections.singletonList(1), "1 ]"},248        };249    }250    @Test251    @Issue("#236")252    @UseDataProvider("parserTestData")253    @CaseAs(value = "$1")254    public void extended_description_should_handle_every_case_correctly(String description, String value,255                                                                        List<String> parameterNames,256                                                                        List<Object> parameterValues,257                                                                        String expectedValue) throws IOException {258        Map<String, String> argumentMap = new LinkedHashMap<>();259        for (int i = 0; i < parameterNames.size(); ++i) {260            String argName = parameterNames.get(i);261            String argValue = String.valueOf(parameterValues.get(i));262            argumentMap.put(argName, argValue);263        }264        given().a_report_model()265            .and().step_$_of_scenario_$_has_extended_description_with_arguments(1, 1, value, argumentMap);266        jsonReports267            .and().the_report_exist_as_JSON_file();268        whenReport.when().the_HTML_Report_Generator_is_executed();269        when().the_page_of_scenario_$_is_opened(1)270            .and().show_tooltip_of_extended_description();271        then().an_element_with_a_$_class_exists("has-tip")272            .and().attribute_$_has_value_$("tooltip-html-unsafe", expectedValue);273    }274    @Test275    @Issue("#274")276    public void a_thumbnail_is_shown_for_image_attachments() throws IOException {277        String screenshot = ((TakesScreenshot) webDriver).getScreenshotAs(OutputType.BASE64);278        given().a_report_model()279            .and().step_$_of_scenario_$_has_an_image_attachment_$(1, 1, screenshot);280        jsonReports281            .and().the_report_exist_as_JSON_file();282        whenReport.when().the_HTML_Report_Generator_is_executed();283        when().the_page_of_scenario_$_is_opened(1);284        then().an_element_with_a_$_class_exists("jgiven-html-thumbnail")285            .and().the_image_is_loaded();286    }287    @Test288    @Issue("#274")289    @DataProvider({290        "true",291        "false"})292    public void showing_thumbnails_can_be_configured(boolean thumbOption) throws IOException {293        String screenshot = ((TakesScreenshot) webDriver).getScreenshotAs(OutputType.BASE64);294        given().a_report_model()295            .and().step_$_of_scenario_$_has_an_image_attachment_$(1, 1, screenshot);296        jsonReports297            .and().the_report_exist_as_JSON_file();298        whenReport.when().showing_thumbnails_is_set_to(thumbOption)299            .and().the_HTML_Report_Generator_is_executed();300        when().the_page_of_scenario_$_is_opened(1);301        if (thumbOption) {302            then().an_element_with_a_$_class_exists("jgiven-html-thumbnail")303                .and().the_image_is_loaded();304        } else {305            then().$_attachment_icons_exist(1);306        }307    }308    @Test309    @Issue("#755")310    public void timings_greater_than_10_millis_are_displayed() throws IOException{311        given().a_report_model().and().step_$_of_scenario_took_$_nanos(0, 11_000_000);312        jsonReports.the_report_exist_as_JSON_file();313        whenReport.when().the_HTML_Report_Generator_is_executed();314        when().the_page_of_scenario_$_is_opened(1);315        then().the_$_th_element_with_a_$_class_exists(2,"duration").has_content("(11ms)");316    }317}...

Source:Html5ReportGeneratorTest.java

...41        given().a_report_model()42            .and().scenario_$_has_tag_$_with_value_$( 1, "TestTag", "123" );43        jsonReports44            .and().the_report_exist_as_JSON_file();45        when().the_HTML_Report_Generator_is_executed();46        then().a_file_$_exists_in_folder_$( "tags.js", "data" )47            .and().a_file_$_exists_in_folder_$( "metaData.js", "data" );48    }49    @Test50    public void the_title_of_the_HTML_report_can_be_configured() throws Exception {51        given().a_report_model();52        jsonReports53            .and().the_report_exist_as_JSON_file();54        when().the_HTML_Report_Generator_is_executed_with_title( "Test Title" );55        then().the_metaData_file_has_title_set_to( "Test Title" );56    }57    @Test58    @FeatureAttachments59    public void attachments_with_different_media_types_can_be_created() throws IOException {60        given().a_report_model();61        attachments62                .and().an_attachment_with_content_$_and_mediaType(JSON_SAMPLE, MediaType.JSON_UTF_8)63                .and().file_name("jsonfile")64                .and().an_attachment_with_binary_content_$_and_mediaType(BINARY_SAMPLE, MediaType.application( "octet-stream" ))65                .and().file_name("binary");66        given()67                .and().the_attachments_are_added_to_step_$_of_case_$(1,1);68        jsonReports69                .and().the_report_exist_as_JSON_file();70        when().the_HTML_Report_Generator_is_executed();71        String folder = "data/attachments/Test".replaceAll("/", Matcher.quoteReplacement(File.separator));72        then().a_file_$_exists_in_folder_$("jsonfile.json", folder)73                .with().content(JSON_SAMPLE)74                .and().a_file_$_exists_in_folder_$("binary.octet-stream", folder)75                .with().binary_content(BINARY_SAMPLE);76    }77}...

Source:WhenHtml5ReportGenerator.java

2import java.io.IOException;3import com.tngtech.jgiven.report.ReportGenerator;4import com.tngtech.jgiven.report.WhenReportGenerator;5public class WhenHtml5ReportGenerator<SELF extends WhenHtml5ReportGenerator<SELF>> extends WhenReportGenerator<SELF> {6    public SELF the_HTML_Report_Generator_is_executed() throws IOException {7        the_report_generator_is_executed_with_format( ReportGenerator.Format.HTML5 );8        return self();9    }10    public SELF the_HTML_Report_Generator_is_executed_with_title( String title ) throws IOException {11        html5ReportConfig.setTitle( title );12        return the_HTML_Report_Generator_is_executed();13    }14    public SELF showing_thumbnails_is_set_to( boolean showThumbnails ) {15        html5ReportConfig.setShowThumbnails( showThumbnails );16        return self();17    }18}...