Merge pull request #365 from devicons/develop

Release v2.7

Author: amacado

.github/scripts/build_assets/SeleniumRunner.py

@@ -36,26 +36,26 @@ class SeleniumRunner:
     """
     ICOMOON_URL = "https://icomoon.io/app/#/select"
 
-    def __init__(self, icomoon_json_path: str, download_path: str,
-                 geckodriver_path: str, headless):
+    def __init__(self, download_path: str,
+                 geckodriver_path: str, headless: bool):
         """
         Create a SeleniumRunner object.
-        :param icomoon_json_path: a path to the iconmoon.json.
         :param download_path: the location where you want to download
         the icomoon.zip to.
         :param geckodriver_path: the path to the firefox executable.
         :param headless: whether to run browser in headless (no UI) mode.
         """
-        self.icomoon_json_path = icomoon_json_path
-        self.download_path = download_path
         self.driver = None
-        self.set_options(geckodriver_path, headless)
+        self.set_options(download_path, geckodriver_path, headless)
 
-    def set_options(self, geckodriver_path: str, headless: bool):
+    def set_options(self, download_path: str, geckodriver_path: str,
+        headless: bool):
         """
         Build the WebDriver with Firefox Options allowing downloads and
         set download to download_path.
+        :param download_path: the location where you want to download
         :param geckodriver_path: the path to the firefox executable.
+        the icomoon.zip to.
         :param headless: whether to run browser in headless (no UI) mode.
 
         :raises AssertionError: if the page title does not contain
@@ -69,25 +69,34 @@ def set_options(self, geckodriver_path: str, headless: bool):
 
         # set the default download path to downloadPath
         options.set_preference("browser.download.folderList", 2)
-        options.set_preference("browser.download.dir", self.download_path)
+        options.set_preference("browser.download.dir", download_path)
         options.headless = headless
 
         self.driver = WebDriver(options=options, executable_path=geckodriver_path)
         self.driver.get(self.ICOMOON_URL)
         assert "IcoMoon App" in self.driver.title
-
-    def upload_icomoon(self):
+        
+        # wait until the whole web page is loaded by testing the hamburger input
+        hamburger_input = WebDriverWait(self.driver, SeleniumRunner.LONG_WAIT_IN_SEC).until(
+            ec.element_to_be_clickable((By.CSS_SELECTOR,
+                "button.btn5.lh-def.transparent i.icon-menu"))
+        )
+        hamburger_input.click()
+        print("Accessed icomoon.io")
+
+    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...")
         try:
             # find the file input and enter the file path
             import_btn = WebDriverWait(self.driver, SeleniumRunner.LONG_WAIT_IN_SEC).until(
-                ec.presence_of_element_located((By.CSS_SELECTOR, "div#file input"))
+                ec.element_to_be_clickable((By.CSS_SELECTOR, "div#file input"))
             )
-            import_btn.send_keys(self.icomoon_json_path)
+            import_btn.send_keys(icomoon_json_path)
         except Exception as e:
             self.close()
             raise e
@@ -130,11 +139,14 @@ def upload_svgs(self, svgs: List[str]):
                 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']"))
             )
             select_all_button.click()
+            print("Finished uploading the svgs...")
         except Exception as e:
             self.close()
             raise e
@@ -152,7 +164,7 @@ def click_hamburger_input(self):
             )
 
             menu_appear_callback = ec.element_to_be_clickable(
-                (By.CSS_SELECTOR, "h1#setH2 ul")
+                (By.CSS_SELECTOR, "h1 ul.menuList2")
             )
 
             while not menu_appear_callback(self.driver):

.github/scripts/build_assets/filehandler.py

@@ -9,8 +9,8 @@
 def find_new_icons(devicon_json_path: str, icomoon_json_path: str) -> List[dict]:
     """
     Find the newly added icons by finding the difference between
-    the devicon_test.json and the icomoon_test.json.
-    :param devicon_json_path, the path to the devicon_test.json.
+    the devicon.json and the icomoon.json.
+    :param devicon_json_path, the path to the devicon.json.
     :param icomoon_json_path: a path to the iconmoon.json.
     :return: a list of the new icons as JSON objects.
     """
@@ -33,8 +33,8 @@ def is_not_in_icomoon_json(icon, icomoon_json) -> bool:
     Checks whether the icon's name is not in the icomoon_json.
     :param icon: the icon object we are searching for.
     :param icomoon_json: the icomoon json object parsed from
-    icomoon_test.json.
-    :return: True if icon's name is not in the icomoon_test.json, else False.
+    icomoon.json.
+    :return: True if icon's name is not in the icomoon.json, else False.
     """
     pattern = re.compile(f"^{icon['name']}-")
 
@@ -46,7 +46,7 @@ def is_not_in_icomoon_json(icon, icomoon_json) -> bool:
 
 def get_svgs_paths(new_icons: List[dict], icons_folder_path: str) -> List[str]:
     """
-    Get all the suitable svgs file path listed in the devicon_test.json.
+    Get all the suitable svgs file path listed in the devicon.json.
     :param new_icons, a list containing the info on the new icons.
     :param icons_folder_path, the path where the function can find the
     listed folders.
@@ -66,7 +66,9 @@ def get_svgs_paths(new_icons: List[dict], icons_folder_path: str) -> List[str]:
             aliases = [] # create empty list of aliases if not provided in devicon.json
 
         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"Not exist {icon_info['name']}-{font_version}.svg")
                 continue
 
             file_name = f"{icon_info['name']}-{font_version}.svg"

.github/scripts/icomoon_peek.py

@@ -0,0 +1,63 @@
+from pathlib import Path
+from argparse import ArgumentParser
+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
+from build_assets.PathResolverAction import PathResolverAction
+
+
+def main():
+    parser = ArgumentParser(description="Upload svgs to Icomoon to create icon files.")
+
+    parser.add_argument("--headless",
+                        help="Whether to run the browser in headless/no UI mode",
+                        action="store_true")
+
+    parser.add_argument("geckodriver_path",
+                        help="The path to the firefox executable file",
+                        action=PathResolverAction)
+
+    parser.add_argument("icomoon_json_path",
+                        help="The path to the icomoon.json aka the selection.json created by Icomoon",
+                        action=PathResolverAction)
+
+    parser.add_argument("devicon_json_path",
+                        help="The path to the devicon.json",
+                        action=PathResolverAction)
+
+    parser.add_argument("icons_folder_path",
+                        help="The path to the icons folder",
+                        action=PathResolverAction)
+
+    parser.add_argument("download_path",
+                        help="The path where you'd like to download the Icomoon files to",
+                        action=PathResolverAction)
+
+    args = parser.parse_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 peek. Ending script...")
+        return
+
+    # print list of new icons, separated by comma
+    print("List of new icons:")
+    print(*new_icons, sep = "\n")
+    try:
+        runner = SeleniumRunner(args.download_path,
+                                args.geckodriver_path, args.headless)
+        svgs = filehandler.get_svgs_paths(new_icons, args.icons_folder_path)
+        runner.upload_svgs(svgs)
+        runner.close()
+        print("Task completed.")
+    except TimeoutException as e:
+        print(e)
+        print(e.stacktrace)
+        runner.close()
+
+
+if __name__ == "__main__":
+    main()

.github/scripts/icomoon_upload.py

@@ -47,9 +47,9 @@ def main():
     print("List of new icons:")
     print(*new_icons, sep = "\n")
     try:
-        runner = SeleniumRunner(args.icomoon_json_path, args.download_path,
+        runner = SeleniumRunner(args.download_path,
                                 args.geckodriver_path, args.headless)
-        runner.upload_icomoon()
+        runner.upload_icomoon(args.icomoon_json_path)
         svgs = filehandler.get_svgs_paths(new_icons, args.icons_folder_path)
         runner.upload_svgs(svgs)
 

.github/workflows/build_icons.yml

@@ -1,11 +1,5 @@
 name: Build Icons
-on:
-  pull_request:
-    branches:
-      - master
-  push:
-    branches:
-      - master
+on: workflow_dispatch
 jobs:
   build:
     name: Get Fonts From Icomoon
@@ -14,6 +8,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           ref: ${{ github.head_ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name}}
       - name: Setup Python v3.8
         uses: actions/setup-python@v2
         with: 
@@ -30,13 +25,26 @@ jobs:
           ./icomoon.json ./devicon.json ./icons ./ --headless
       - name: Upload geckodriver.log for debugging purposes
         uses: actions/upload-artifact@v2
+        if: ${{failure()}}
         with:
           name: geckodriver-log
           path: ./geckodriver.log
-      - name: Running gulp default task for building devicon.min.css
-        run: |
-          gulp default
-      - name: Commit changes
-        uses: stefanzweifel/git-auto-commit-action@v4
+      - name: Upload screenshot of the newly made icons
+        uses: actions/upload-artifact@v2
+        if: ${{success()}}
+        with:
+          name: new_icons
+          path: ./new_icons.png
+      - name: Running npm task for building devicon.min.css
+        if: ${{ success() }}
+        run: npm run build-css
+      - name: Create Pull Request
+        if: ${{ success() }}
+        uses: peter-evans/create-pull-request@v3
         with:
-          commit_message: Build new icons, icomoon.json and devicon.css
+          branch: ${{ format('build/{0}', github.head_ref) }}
+          base: 'develop'
+          commit-message: 'Built new icons, icomoon.json and devicon.css'
+          title: 'bot:build new icons, icomoon.json and devicon.css'
+          body: 'Automated font-building task ran by GitHub Actions bot'
+          delete-branch: true

.github/workflows/peek_icons.yml

@@ -0,0 +1,54 @@
+name: Peek Icons
+on:
+  pull_request:
+      types: [labeled]
+jobs:
+  build:
+    name: Get Fonts From Icomoon
+    if: contains(github.event.pull_request.labels.*.name, 'bot:peek')
+    runs-on: windows-2019
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name}}
+      - name: Setup Python v3.8
+        uses: actions/setup-python@v2
+        with: 
+          python-version: 3.8
+      - name: Install dependencies (python, pip, npm)
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ./.github/scripts/requirements.txt
+          npm install
+      - name: Run icomoon_peek.py
+        run: >
+          python ./.github/scripts/icomoon_peek.py 
+          ./.github/scripts/build_assets/geckodriver-v0.27.0-win64/geckodriver.exe
+          ./icomoon.json ./devicon.json ./icons ./ --headless
+      - name: Upload geckodriver.log for debugging purposes
+        uses: actions/upload-artifact@v2
+        if: ${{failure()}}
+        with:
+          name: geckodriver-log
+          path: ./geckodriver.log
+      - name: Upload screenshot of the newly made icons
+        uses: actions/upload-artifact@v2
+        if: ${{success()}}
+        with:
+          name: new_icons
+          path: ./new_icons.png
+      # - name: Comment on the PR about the result
+      #   uses: github-actions-up-and-running/pr-comment@v1.0.1
+      #   with:
+      #     repo-token: ${{ secrets.GITHUB_TOKEN }}
+      #     message: >
+      #       Hi! I'm Devicons' GitHub Actions Bot!
+            
+      #       I just peeked at the icons that you wanted to add and upload them to the 
+      #       [Actions page](https://github.com/devicons/devicon/actions). The maintainers
+      #       will now take a look at it and decide whether to merge your PR.
+
+      #       Cheers :),
+      
+      #       Bot

.gitignore

@@ -3,4 +3,5 @@ node_modules
 .idea
 geckodriver.log
 __pycache__
-*.pyc
+*.pyc
+new_icons.png