Release v2.8.0

.github/ISSUE_TEMPLATE/icon-request.md

@@ -2,7 +2,7 @@
 name: Icon request
 about: Requesting a new icon or changes to an existing icon
 title: 'Icon request: [NAME]'
-labels: 'request: icon'
+labels: 'request:icon'
 assignees: ''
 
 ---

.github/scripts/build_assets/SeleniumRunner.py

@@ -89,70 +89,54 @@ def upload_icomoon(self, icomoon_json_path: str):
         :raises TimeoutException: happens when elements are not found.
         """
         print("Uploading icomoon.json file...")
-        try:
-            self.click_hamburger_input()
-
-            # find the file input and enter the file path
-            import_btn = self.driver.find_element(By.XPATH, "(//li[@class='file'])[1]//input")
-            import_btn.send_keys(icomoon_json_path)
-        except SeleniumTimeoutException as e:
-            print(e.stacktrace)
-            print("Selenium timed out. Couldn't find import button.")
-            self.close()
-            raise e
-        except Exception as e:
-            self.close()
-            raise e
+        self.click_hamburger_input()
+
+        # find the file input and enter the file path
+        import_btn = self.driver.find_element(By.XPATH, "(//li[@class='file'])[1]//input")
+        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:
-            print(e.stacktrace)
-            print("Cannot find the confirm button when uploading the icomoon.json",
-                  "Ensure that the icomoon.json is in the correct format for Icomoon.io",
-                  sep='\n')
-            self.close()
+            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]):
+    def upload_svgs(self, svgs: List[str], screenshot_folder: str=""):
         """
         Upload the SVGs provided in folder_info
         :param svgs: a list of svg Paths that we'll upload to icomoon.
+        :param screenshot_folder: the name of the screenshot_folder. If
+        the value is provided, it means the user want to take a screenshot
+        of each icon.
         """
-        try:
-            print("Uploading SVGs...")
+        print("Uploading SVGs...")
 
-            edit_mode_btn = self.driver.find_element_by_css_selector(
-                "div.btnBar button i.icon-edit"
-            )
-            edit_mode_btn.click()
-
-            self.click_hamburger_input()
-
-            for svg in svgs:
-                import_btn = self.driver.find_element_by_css_selector(
-                    "li.file input[type=file]"
-                )
-                import_btn.send_keys(svg)
-                print(f"Uploaded {svg}")
-                self.test_for_possible_alert(self.SHORT_WAIT_IN_SEC, "Dismiss")
-                self.remove_color_from_icon()
-
-            # take a screenshot of the icons that were just added
-            self.driver.save_screenshot("new_icons.png");
-            self.click_hamburger_input()
-            select_all_button = WebDriverWait(self.driver, self.LONG_WAIT_IN_SEC).until(
-                ec.element_to_be_clickable((By.XPATH, "//button[text()='Select All']"))
+        edit_mode_btn = self.driver.find_element_by_css_selector(
+            "div.btnBar button i.icon-edit"
+        )
+        edit_mode_btn.click()
+
+        self.click_hamburger_input()
+
+        for i in range(len(svgs)):
+            import_btn = self.driver.find_element_by_css_selector(
+                "li.file input[type=file]"
             )
-            select_all_button.click()
-            print("Finished uploading the svgs...")
-        except Exception as e:
-            self.close()
-            raise e
+            import_btn.send_keys(svgs[i])
+            print(f"Uploaded {svgs[i]}")
+            self.test_for_possible_alert(self.SHORT_WAIT_IN_SEC, "Dismiss")
+            self.click_on_just_added_icon(screenshot_folder, i)
+
+        # take a screenshot of the icons that were just added
+        new_icons_path = str(Path(screenshot_folder, "new_icons.png").resolve())
+        self.driver.save_screenshot(new_icons_path);
+
+        print("Finished uploading the svgs...")
 
     def click_hamburger_input(self):
         """
@@ -161,20 +145,16 @@ def click_hamburger_input(self):
         input two times before the menu appears.
         :return: None.
         """
-        try:
-            hamburger_input = self.driver.find_element_by_xpath(
-                "(//i[@class='icon-menu'])[2]"
-            )
+        hamburger_input = self.driver.find_element_by_xpath(
+            "(//i[@class='icon-menu'])[2]"
+        )
 
-            menu_appear_callback = ec.element_to_be_clickable(
-                (By.CSS_SELECTOR, "h1 ul.menuList2")
-            )
+        menu_appear_callback = ec.element_to_be_clickable(
+            (By.CSS_SELECTOR, "h1 ul.menuList2")
+        )
 
-            while not menu_appear_callback(self.driver):
-                hamburger_input.click()
-        except Exception as e:
-            self.close()
-            raise e
+        while not menu_appear_callback(self.driver):
+            hamburger_input.click()
 
     def test_for_possible_alert(self, wait_period: float, btn_text: str):
         """
@@ -191,22 +171,37 @@ def test_for_possible_alert(self, wait_period: float, btn_text: str):
             )
             dismiss_btn.click()
         except SeleniumTimeoutException:
-            pass
+            pass  # nothing found => everything is good
+
+    def click_on_just_added_icon(self, screenshot_folder: str, index: int):
+        """
+        Click on the most recently added icon so we can remove the colors
+        and take a snapshot if needed.
+        """
+        recently_uploaded_icon = WebDriverWait(self.driver, self.LONG_WAIT_IN_SEC).until(
+            ec.element_to_be_clickable((By.XPATH, "//div[@id='set0']//mi-box[1]//div"))
+        )
+        recently_uploaded_icon.click()
+
+        self.remove_color_from_icon()
+
+        if screenshot_folder:
+            screenshot_path = str(Path(screenshot_folder, f"screenshot_{index}.png").resolve())
+            self.driver.save_screenshot(screenshot_path)
+            print("Took screenshot and saved it at " + screenshot_path)
+
+        close_btn = self.driver \
+            .find_element_by_css_selector("div.overlayWindow i.icon-close")
+        close_btn.click()
 
     def remove_color_from_icon(self):
         """
         Remove the color from the most recent uploaded icon.
-        :return: None.
+        This is because some SVG have colors in them and we don't want to
+        force contributors to remove them in case people want the colored SVGs.
+        The color removal is also necessary so that the Icomoon-generated
+        icons fit within one font symbol/ligiature.
         """
-        try:
-            recently_uploaded_icon = WebDriverWait(self.driver, self.LONG_WAIT_IN_SEC).until(
-                ec.element_to_be_clickable((By.XPATH, "//div[@id='set0']//mi-box[1]//div"))
-            )
-            recently_uploaded_icon.click()
-        except Exception as e:
-            self.close()
-            raise e
-
         try:
             color_tab = WebDriverWait(self.driver, self.SHORT_WAIT_IN_SEC).until(
                 ec.element_to_be_clickable((By.CSS_SELECTOR, "div.overlayWindow i.icon-droplet"))
@@ -217,42 +212,35 @@ def remove_color_from_icon(self):
                 .find_element_by_css_selector("div.overlayWindow i.icon-droplet-cross")
             remove_color_btn.click()
         except SeleniumTimeoutException:
-            pass
-        except Exception as e:
-            self.close()
-            raise e
-
-        try:
-            close_btn = self.driver \
-                .find_element_by_css_selector("div.overlayWindow i.icon-close")
-            close_btn.click()
-        except Exception as e:
-            self.close()
-            raise e
+            pass # do nothing cause sometimes, the color tab doesn't appear in the site
 
     def download_icomoon_fonts(self, zip_path: Path):
         """
         Download the icomoon.zip from icomoon.io.
         :param zip_path: the path to the zip file after it's downloaded.
         """
-        try:
-            print("Downloading Font files...")
-            self.driver.find_element_by_css_selector(
-                "a[href='#/select/font']"
-            ).click()
-
-            self.test_for_possible_alert(self.MED_WAIT_IN_SEC, "Continue")
-            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.")
-        except Exception as e:
-            self.close()
-            raise e
+        # select all the svgs so that the newly added svg are part of the collection
+        self.click_hamburger_input()
+        select_all_button = WebDriverWait(self.driver, self.LONG_WAIT_IN_SEC).until(
+            ec.element_to_be_clickable((By.XPATH, "//button[text()='Select All']"))
+        )
+        select_all_button.click()
+
+        print("Downloading Font files...")
+        font_tab = self.driver.find_element_by_css_selector(
+            "a[href='#/select/font']"
+        )
+        font_tab.click()
+
+        self.test_for_possible_alert(self.MED_WAIT_IN_SEC, "Continue")
+        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:
         """

.github/scripts/build_assets/util.py → .github/scripts/build_assets/arg_getters.py

@@ -1,8 +1,8 @@
-from pathlib import Path
 from argparse import ArgumentParser
 from build_assets.PathResolverAction import PathResolverAction
 
-def get_commandline_args():
+
+def get_selenium_runner_args(peek_mode=False):
     parser = ArgumentParser(description="Upload svgs to Icomoon to create icon files.")
 
     parser.add_argument("--headless",
@@ -26,8 +26,11 @@ def get_commandline_args():
                         action=PathResolverAction)
 
     parser.add_argument("download_path",
-                        help="The path where you'd like to download the Icomoon files to",
+                        help="The download destination of the Icomoon files",
                         action=PathResolverAction)
 
+    if peek_mode:
+        parser.add_argument("--pr_title",
+                            help="The title of the PR that we are peeking at")
 
     return parser.parse_args()

.github/scripts/build_assets/filehandler.py

@@ -145,3 +145,24 @@ def rename_extracted_files(extract_path: str):
         os.replace(dict_["old"], dict_["new"])
 
     print("Files renamed")
+
+
+def create_screenshot_folder(dir, screenshot_name: str="screenshots/"):
+    """
+    Create a screenshots folder in the dir.
+    :param dir, the dir where we want to create the folder.
+    :param screenshot_name, the name of the screenshot folder.
+    :raise Exception if the dir provided is not a directory.
+    :return the string name of the screenshot folder.
+    """
+    folder = Path(dir).resolve()
+    if not folder.is_dir():
+        raise Exception(f"This is not a dir: {str(folder)}. \ndir must be a valid directory")
+
+    screenshot_folder = Path(folder, screenshot_name)
+    try:
+        os.mkdir(screenshot_folder)
+    except FileExistsError:
+        print(f"{screenshot_folder} already exist. Script will do nothing.")
+    finally:
+        return str(screenshot_folder)

.github/scripts/generate_screenshot_markdown.py

@@ -0,0 +1,10 @@
+import json
+import os
+
+
+if __name__ == "__main__":
+    img_urls_list = json.loads(os.environ["IMG_URLS"])
+    template = "![Detailed Screenshot]({})"
+    markdown = [template.format(img_url) for img_url in img_urls_list]
+    print("\n\n".join(markdown))
+

.github/scripts/icomoon_build.py

@@ -1,18 +1,18 @@
 from pathlib import Path
+import sys
 from selenium.common.exceptions import TimeoutException
 
 # pycharm complains that build_assets is an unresolved ref
 # don't worry about it, the script still runs
 from build_assets.SeleniumRunner import SeleniumRunner
-from build_assets import filehandler, util
+from build_assets import filehandler, arg_getters
 
 
 def main():
-    args = util.get_commandline_args()
+    args = arg_getters.get_selenium_runner_args()
     new_icons = filehandler.find_new_icons(args.devicon_json_path, args.icomoon_json_path)
     if len(new_icons) == 0:
-        print("No files need to be uploaded. Ending script...")
-        return
+        sys.exit("No files need to be uploaded. Ending script...")
 
     # print list of new icons
     print("List of new icons:", *new_icons, sep = "\n")
@@ -32,10 +32,11 @@ def main():
         filehandler.rename_extracted_files(args.download_path)
         print("Task completed.")
     except TimeoutException as e:
-        print(e)
-        print(e.stacktrace)
+        sys.exit("Selenium Time Out Error: \n" + str(e))
+    except Exception as e:
+        sys.exit(e)
     finally:
-        runner.close()
+        runner.close() 
 
 
 if __name__ == "__main__":