"""Test template packs.""" import os import zipfile import tempfile import base64 from selenium.webdriver.support.ui import Select from vasl_templates.webapp import snippets from vasl_templates.webapp.tests.utils import \ select_tab, select_menu_option, get_clipboard, get_stored_msg, set_stored_msg, set_stored_msg_marker,\ add_simple_note, for_each_template, find_child, find_children, wait_for, \ select_droplist_val, get_droplist_vals_index, init_webapp # --------------------------------------------------------------------- def test_individual_files( webapp, webdriver ): """Test loading individual template files.""" # initialize init_webapp( webapp, webdriver, template_pack_persistence=1 ) # try uploading a customized version of each template def test_template( template_id, orig_template_id ): """Test uploading a customized version of the template.""" # make sure generating a snippet returns something elem, clipboard = _generate_snippet( template_id, orig_template_id ) assert clipboard != "" # upload a new template _ = _upload_template_pack_file( template_id+".j2", "UPLOADED TEMPLATE", False ) # make sure generating a snippet returns the new version elem.click() assert get_clipboard() == "UPLOADED TEMPLATE" for_each_template( test_template ) # try uploading a template with an incorrect filename extension _ = _upload_template_pack_file( "filename.xyz", "UPLOADED TEMPLATE", True ) assert "Invalid template extension" in get_stored_msg( "_last-error_" ) # try uploading a template with an unknown filename _ = _upload_template_pack_file( "unknown.j2", "UPLOADED TEMPLATE", True ) assert "Invalid template filename" in get_stored_msg( "_last-error_" ) # --------------------------------------------------------------------- def test_zip_files( webapp, webdriver ): """Test loading ZIP'ed template packs.""" # initialize init_webapp( webapp, webdriver, template_pack_persistence=1 ) # upload a template pack that contains a full set of templates zip_data = _make_zip_from_files( "full" ) _, marker = _upload_template_pack_zip( zip_data, False ) assert get_stored_msg( "_last-error_" ) == marker # check that the uploaded templates are being used _check_snippets( lambda tid: "Customized {}.".format( tid.upper() ) ) # upload only part of template pack _ = _upload_template_pack_zip( zip_data[ : int(len(zip_data)/2) ], True ) assert get_stored_msg( "_last-error_" ).startswith( "Can't unpack the ZIP:" ) # try uploading an empty template pack _ = _upload_template_pack_zip( b"", True ) assert get_stored_msg( "_last-error_" ).startswith( "Can't unpack the ZIP:" ) # NOTE: We can't test the limit on template pack size, since it happens after the browser's # "open file" dialog has finished, but before we read the file data (i.e. we don't execute # that bit of code since we're using the "template_pack_persistence" hack). # --------------------------------------------------------------------- def test_new_default_template_pack( webapp, webdriver, monkeypatch ): """Test changing the default template pack.""" # configure a new default template pack dname = os.path.join( os.path.split(__file__)[0], "fixtures/template-packs/new-default/" ) monkeypatch.setattr( snippets, "default_template_pack", dname ) # initialize init_webapp( webapp, webdriver ) # check that the new templates are being used _check_snippets( lambda tid: "New default {}.".format( tid.upper() ) ) # --------------------------------------------------------------------- def test_nationality_data( webapp, webdriver ): """Test a template pack with nationality data.""" # initialize init_webapp( webapp, webdriver, template_pack_persistence=1 ) select_tab( "scenario" ) # select the British as player 1 player1_sel = Select( find_child( "select[name='PLAYER_1']" ) ) select_droplist_val( player1_sel, "british" ) tab_ob1 = find_child( "a[href='#tabs-ob1']" ) assert tab_ob1.text.strip() == "British OB" # FUDGE! player1_sel.first_selected_option.text doesn't contain the right value # if we're using jQuery selectmenu's :-/ assert player1_sel.first_selected_option.get_attribute( "value" ) == "british" droplist_vals = get_droplist_vals_index( player1_sel ) assert droplist_vals["british"] == "British" # upload a template pack that contains nationality data zip_data = _make_zip_from_files( "with-nationality-data" ) _, marker = _upload_template_pack_zip( zip_data, False ) assert get_stored_msg( "_last-error_" ) == marker # check that the UI was updated correctly assert tab_ob1.text.strip() == "Poms! OB" assert player1_sel.first_selected_option.get_attribute( "value" ) == "british" droplist_vals2 = get_droplist_vals_index( player1_sel ) assert droplist_vals2["british"] == "Poms!" # check that there is a new Korean player del droplist_vals2["korean"] droplist_vals2 = { k: "British" if v == "Poms!" else v for k,v in droplist_vals2.items() } assert droplist_vals2 == droplist_vals # --------------------------------------------------------------------- def _make_zip( files ): """Generate a ZIP file.""" with tempfile.NamedTemporaryFile() as temp_file: temp_file.close() with zipfile.ZipFile( temp_file.name, "w" ) as zip_file: for fname,fdata in files.items(): zip_file.writestr( fname, fdata ) return open( temp_file.name, "rb" ).read() def _make_zip_from_files( dname ): """Generate a ZIP file from files in a directory.""" files = {} dname = os.path.join( os.path.split(__file__)[0], "fixtures/template-packs/"+dname ) for root,_,fnames in os.walk(dname): for fname in fnames: fname = os.path.join( root, fname ) assert fname.startswith( dname ) fname2 = fname[len(dname)+1:] with open( fname, "r" ) as fp: files[fname2] = fp.read() return _make_zip( files ) # --------------------------------------------------------------------- def _check_snippets( expected ): """Check that snippets are being generated as expected.""" def test_template( template_id, orig_template_id ): """Test each template.""" _, clipboard = _generate_snippet( template_id, orig_template_id ) assert clipboard == expected( template_id ) for_each_template( test_template ) # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - def _generate_snippet( template_id, orig_template_id ): """Generate a snippet for the specified template.""" if template_id == "scenario_note": # create a scenario note and generate a snippet for it sortable = find_child( "#scenario_notes-sortable" ) add_simple_note( sortable, "test scenario note", None ) elems = find_children( "li img.snippet", sortable ) elem = elems[0] elif template_id in ("ob_setup","ob_note"): # create a OB setup/note and generate a snippet for it select_tab( "ob1" ) sortable = find_child( "#{}s-sortable_1".format( template_id ) ) add_simple_note( sortable, "test {}".format(template_id), None ) elems = find_children( "#{}s-sortable_1 li img.snippet".format( template_id ) ) elem = elems[0] else: # generate a snippet for the specified template elem = find_child( "button.generate[data-id='{}']".format( orig_template_id ) ) elem.click() return elem, get_clipboard() # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - def _upload_template_pack_zip( zip_data, error_expected ): """Upload a template pack ZIP.""" return _do_upload_template_pack( "{} | {}".format( "test.zip", base64.b64encode( zip_data ).decode( "ascii" ) ), error_expected ) def _upload_template_pack_file( fname, data, error_expected ): """Upload a template pack file.""" return _do_upload_template_pack( "{} | {}".format( fname, data ), error_expected ) def _do_upload_template_pack( data, error_expected ): """Upload a template pack.""" # upload the template pack set_stored_msg( "_template-pack-persistence_", data ) info_marker = set_stored_msg_marker( "_last-info_" ) error_marker = set_stored_msg_marker( "_last-error_" ) select_menu_option( "template_pack" ) # wait for the front-end to finish if error_expected: func = lambda: get_stored_msg("_last-error_") != error_marker else: func = lambda: "was loaded" in get_stored_msg("_last-info_") wait_for( 2, func ) return info_marker, error_marker