new icon: testingicon (original, plain)

.github/scripts/build_assets/filehandler.py

@@ -91,7 +91,7 @@ def get_icon_svgs_paths(folder_path: Path, icon_info: dict,
     for font_version in icon_info["versions"]["font"]:
         # if it's an alias, we don't want to make it into an icon
         if is_alias(font_version, aliases):
-            print(f"Skipping this font since it's an alias: {icon_info['name']}-{font_version}.svg")
+            print(f"Finding SVG filepaths: skipping this font since it's an alias: {icon_info['name']}-{font_version}.svg")
             continue
 
         file_name = f"{icon_info['name']}-{font_version}.svg"
@@ -203,7 +203,7 @@ def create_screenshot_folder(dir, screenshot_name: str="screenshots/"):
     try:
         os.mkdir(screenshot_folder)
     except FileExistsError:
-        print(f"{screenshot_folder} already exist. Script will do nothing.")
+        print(f"{screenshot_folder} already exist. Not creating new folder.")
     finally:
         return str(screenshot_folder)
 

.github/scripts/build_assets/selenium_runner/BuildSeleniumRunner.py

@@ -0,0 +1,138 @@
+from typing import List
+import time
+from pathlib import Path
+
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as ec
+from selenium.common.exceptions import TimeoutException as SeleniumTimeoutException
+
+from build_assets.selenium_runner.SeleniumRunner import SeleniumRunner, IcomoonPage, IcomoonOptionState
+
+class BuildSeleniumRunner(SeleniumRunner):
+    def build_icons(self, icomoon_json_path: str,
+        zip_path: Path, svgs: List[str], screenshot_folder: str):
+        self.upload_icomoon(icomoon_json_path)
+        # necessary so we can take screenshot of only the 
+        # recently uploaded icons later
+        self.deselect_all_icons_in_top_set()
+        self.upload_svgs(svgs, screenshot_folder)
+        self.take_icon_screenshot(screenshot_folder)
+        self.download_icomoon_fonts(zip_path)
+
+    def upload_icomoon(self, icomoon_json_path: str):
+        """
+        Upload the icomoon.json to icomoon.io.
+        :param icomoon_json_path: a path to the iconmoon.json.
+        :raises TimeoutException: happens when elements are not found.
+        """
+        print("Uploading icomoon.json file...")
+
+        # find the file input and enter the file path
+        import_btn = self.driver.find_element_by_css_selector(
+            SeleniumRunner.GENERAL_IMPORT_BUTTON_CSS
+        )
+        import_btn.send_keys(icomoon_json_path)
+
+        try:
+            confirm_btn = WebDriverWait(self.driver, SeleniumRunner.MED_WAIT_IN_SEC).until(
+                ec.element_to_be_clickable((By.XPATH, "//div[@class='overlay']//button[text()='Yes']"))
+            )
+            confirm_btn.click()
+        except SeleniumTimeoutException as e:
+            raise Exception("Cannot find the confirm button when uploading the icomoon.json" \
+                  "Ensure that the icomoon.json is in the correct format for Icomoon.io")
+
+        print("JSON file uploaded.")
+
+    def upload_svgs(self, svgs: List[str], screenshot_folder: str):
+        """
+        Upload the SVGs provided in svgs. This will upload the 
+        :param svgs: a list of svg Paths that we'll upload to icomoon.
+        :param screenshot_folder: the name of the screenshot_folder. 
+        """
+        print("Uploading SVGs...")
+
+        import_btn = self.driver.find_element_by_css_selector(
+            SeleniumRunner.SET_IMPORT_BUTTON_CSS
+        )
+
+        dismiss_btn_text = "Dismiss"
+        replace_btn_text = "Replace"
+        for i in range(len(svgs)):
+            import_btn.send_keys(svgs[i])
+            print(f"Uploading {svgs[i]}")
+            # see if there are stroke messages or replacing icon message
+            # there should be none of the second kind
+            self.test_for_possible_alert(self.SHORT_WAIT_IN_SEC, dismiss_btn_text)
+            if self.test_for_possible_alert(self.SHORT_WAIT_IN_SEC, replace_btn_text):
+                message = f"Duplicated SVG: check for {svgs[i]}."
+                raise Exception(message)
+            self.edit_svg()
+            print(f"Finished editing icon.")
+
+        # take a screenshot of the svgs that were just added
+        # select the latest icons
+        self.switch_toolbar_option(IcomoonOptionState.SELECT)
+        self.click_latest_icons_in_top_set(len(svgs)) 
+        new_icons_path = str(Path(screenshot_folder, "new_svgs.png").resolve())
+        self.driver.save_screenshot(new_icons_path);
+
+        print("Finished uploading the svgs...")
+
+    def take_icon_screenshot(self, screenshot_folder: str):
+        """
+        Take the overview icon screenshot of the uploaded icons.
+        :param svgs: a list of svg Paths that we'll upload to icomoon.
+        :param screenshot_folder: the name of the screenshot_folder. 
+        """
+        # take pictures
+        print("Taking screenshot of the new icons...")
+        self.go_to_page(IcomoonPage.GENERATE_FONT)
+
+        # take an overall screenshot of the icons that were just added
+        # also include the glyph count
+        new_icons_path = str(Path(screenshot_folder, "new_icons.png").resolve())
+        main_content_xpath = "/html/body/div[4]/div[2]/div/div[1]"
+        main_content = self.driver.find_element_by_xpath(main_content_xpath)
+        main_content.screenshot(new_icons_path)
+        print("Saved screenshot of the new icons...")
+
+    def download_icomoon_fonts(self, zip_path: Path):
+        """
+        Download the icomoon.zip from icomoon.io. Also take a picture of 
+        what the icons look like.
+        :param zip_path: the path to the zip file after it's downloaded.
+        """
+        print("Downloading Font files...")
+        if self.current_page != IcomoonPage.SELECTION:
+            self.go_to_page(IcomoonPage.SELECTION)
+
+        self.select_all_icons_in_top_set()
+        self.go_to_page(IcomoonPage.GENERATE_FONT)
+
+        download_btn = WebDriverWait(self.driver, SeleniumRunner.LONG_WAIT_IN_SEC).until(
+            ec.presence_of_element_located((By.CSS_SELECTOR, "button.btn4 span"))
+        )
+        download_btn.click()
+        if self.wait_for_zip(zip_path):
+            print("Font files downloaded.")
+        else:
+            raise TimeoutError(f"Couldn't find {zip_path} after download button was clicked.")
+
+    def wait_for_zip(self, zip_path: Path) -> bool:
+        """
+        Wait for the zip file to be downloaded by checking for its existence
+        in the download path. Wait time is self.LONG_WAIT_IN_SEC and check time
+        is 1 sec.
+        :param zip_path: the path to the zip file after it's
+        downloaded.
+        :return: True if the file is found within the allotted time, else
+        False.
+        """
+        end_time = time.time() + self.LONG_WAIT_IN_SEC
+        while time.time() <= end_time:
+            if zip_path.exists():
+                return True
+            time.sleep(1)  # wait so we don't waste sys resources
+        return False

.github/scripts/build_assets/selenium_runner/PeekSeleniumRunner.py

@@ -0,0 +1,75 @@
+from typing import List
+from pathlib import Path
+
+from build_assets.selenium_runner.SeleniumRunner import SeleniumRunner, IcomoonPage
+
+class PeekSeleniumRunner(SeleniumRunner):
+    def peek(self, svgs: List[str], screenshot_folder: str):
+        """
+        Upload the SVGs and peek at how Icomoon interpret its SVGs and
+        font versions.
+        :param svgs: a list of svg Paths that we'll upload to icomoon.
+        :param screenshot_folder: the name of the screenshot_folder. 
+        """
+        # enforce ordering
+        self.peek_svgs(svgs, screenshot_folder)        
+        self.peek_icons(svgs, screenshot_folder)
+
+    def peek_svgs(self, svgs: List[str], screenshot_folder: str):
+        """
+        Peek at the SVGs provided in svgs. This will look at how Icomoon
+        interprets the SVGs as a font.
+        :param svgs: a list of svg Paths that we'll upload to icomoon.
+        :param screenshot_folder: the name of the screenshot_folder. 
+        """
+        print("Peeking SVGs...")
+
+        import_btn = self.driver.find_element_by_css_selector(
+            SeleniumRunner.GENERAL_IMPORT_BUTTON_CSS
+        )
+
+        for i in range(len(svgs)):
+            import_btn.send_keys(svgs[i])
+            print(f"Uploaded {svgs[i]}")
+            self.test_for_possible_alert(self.SHORT_WAIT_IN_SEC, "Dismiss")
+            self.edit_svg(screenshot_folder, i)
+
+        # take a screenshot of the svgs that were just added
+        self.select_all_icons_in_top_set()
+        new_svgs_path = str(Path(screenshot_folder, "new_svgs.png").resolve())
+        icon_set_xpath = "/html/body/div[4]/div[1]/div[2]/div[1]"
+        icon_set = self.driver.find_element_by_xpath(icon_set_xpath)
+        icon_set.screenshot(new_svgs_path);
+
+        print("Finished peeking the svgs...")
+
+    def peek_icons(self, svgs: List[str], screenshot_folder: str):
+        """
+        Peek at the icon versions of the SVGs that were uploaded.
+        :param screenshot_folder: the name of the screenshot_folder. 
+        """
+        print("Begin peeking at the icons...")
+        # ensure all icons in the set is selected.
+        self.select_all_icons_in_top_set()
+        self.go_to_page(IcomoonPage.GENERATE_FONT)
+
+        # take an overall screenshot of the icons that were just added
+        # also include the glyph count
+        new_icons_path = str(Path(screenshot_folder, "new_icons.png").resolve())
+        main_content_xpath = "/html/body/div[4]/div[2]/div/div[1]"
+        main_content = self.driver.find_element_by_xpath(main_content_xpath)
+        main_content.screenshot(new_icons_path);
+
+        # go downward so we get the oldest icon first
+        len_ = len(svgs)
+        for i in range(len_, 0, -1):
+            xpath = f'//*[@id="glyphSet0"]/div[{i}]'
+            icon_div = self.driver.find_element_by_xpath(xpath)
+
+            # crop the div out from the screenshot
+            icon_screenshot = str(
+                Path(screenshot_folder, f"new_icon_{len_ - i}.png").resolve()
+            )
+            icon_div.screenshot(icon_screenshot)
+
+        print("Finished peeking the icons...")