feat: plone-theme-upload-notify

BIBLI-60

Author: remdub

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v3.8] - 2024-08-08
+### Added
+- plone-theme-build-push-notify
+
 ## [v3.7.2] - 2024-07-31
 ### Fixed
 - rundeck-notify

README.md

@@ -133,6 +133,25 @@ Test a Plone package and optionally notify via a mattermost webhook
 
 /
 
+---
+### plone-theme-build-push-notify
+
+Build a theme, upload it to a plone site and optionally notify on Mattermost
+
+#### Inputs
+
+| name                   | required | type   | default      | description |
+| ---------------------- | -------- | ------ | -------------| ----------- |
+| THEME_PATH             |    yes   | string |              | Folder where theme files are located |
+| PLONE_URL              |    yes   | string |              | URL of the Plone site |
+| PLONE_USERNAME         |    yes   | string |              | Username to login to Plone |
+| PLONE_PASSWORD         |    yes   | string |              | Password to login to Plone |
+| MATTERMOST_WEBHOOK_URL |    no    | string |              | Webhook URL to send notifications on Mattermost |
+
+#### Example of usage
+
+/
+
 ---
 ### rundeck-notify
 

plone-theme-build-push-notify/action.yml

@@ -0,0 +1,62 @@
+name: Upload plone theme and notify on Mattermost
+description: Upload a theme to a plone site and optionally notify on Mattermost
+inputs:
+  THEME_PATH:
+    description: 'Folder where theme files are located'
+    required: true
+  PLONE_URL:
+    description: 'URL of the Plone site'
+    required: true
+  PLONE_USERNAME:
+    description: 'Username to login to Plone'
+    required: true
+  PLONE_PASSWORD:
+    description: 'Password to login to Plone'
+    required: true
+  MATTERMOST_WEBHOOK_URL:
+    description: 'Webhook URL to send notifications on Mattermost, if not provided, notifications will not be sent'
+    required: false
+runs:
+  using: 'composite'
+  steps:
+    - name: Install curl
+      run: |
+        if which curl > /dev/null ; then
+          echo "curl is already installed"
+        else
+          sudo apt-get update && sudo apt-get install -y curl
+        fi
+      shell: bash
+    - name: Install pip3 and python packages
+      run: |
+        if which pip3 > /dev/null ; then
+          echo "pip3 is already installed"
+        else
+          sudo apt-get update && sudo apt-get install -y python3-pip && pip3 install bs4 requests
+        fi
+      shell: bash
+    - name: Install node dev dependencies
+      run: |
+        pnpm install --no-frozen-lockfile
+      shell: bash
+    - name: Build themes
+      run: |
+        echo Building theme for ${{ inputs.THEME_PATH }}
+        pnpm --theme=${{ inputs.THEME_PATH }} build
+      shell: bash
+    - name: Upload theme
+      run: |
+        python3 ${{ github.action_path }}/theme_uploader.py ${{ inputs.PLONE_URL }} ${{ inputs.PLONE_USERNAME }} ${{ inputs.PLONE_PASSWORD }} ${{ inputs.THEME_PATH }} theme.zip
+      shell: bash
+    - name : Send notification on Mattermost
+      if: ${{ inputs.MATTERMOST_WEBHOOK_URL != '' }}
+      uses: IMIO/gha/[email protected]
+      with:
+        MATTERMOST_WEBHOOK_URL: ${{ inputs.MATTERMOST_WEBHOOK_URL }}
+        MESSAGE: "Theme has been successfully uploaded to Plone site ${{ inputs.PLONE_URL }}"
+    - name : Send failure notification on Mattermost
+      if: ${{ failure() && inputs.MATTERMOST_WEBHOOK_URL != '' }}
+      uses: IMIO/gha/[email protected]
+      with:
+        MATTERMOST_WEBHOOK_URL: ${{ inputs.MATTERMOST_WEBHOOK_URL }}
+        MESSAGE: "An error has been encountered while uploading theme to Plone site ${{ inputs.PLONE_URL }}"

plone-theme-build-push-notify/theme_uploader.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Plone theme uploader
+
+This script is used to upload a theme to a Plone instance.
+
+Usage:
+    python theme_uploader.py INSTANCE_URL USERNAME PASSWORD THEME_LOCATION
+"""
+
+from bs4 import BeautifulSoup
+
+import requests
+import requests.cookies
+import sys
+
+INSTANCE_URL = sys.argv[1]
+USERNAME = sys.argv[2]
+PASSWORD = sys.argv[3]
+THEME_PATH = sys.argv[4]
+THEME_FILENAME = sys.argv[5]
+
+
+def authenticate(
+    session: requests.Session, login_url: str, username: str, password: str
+) -> requests.Response:
+    url = INSTANCE_URL + "/failsafe_login"
+    data = {
+        "__ac_name": USERNAME,
+        "__ac_password": PASSWORD,
+        "came_from": f"{INSTANCE_URL}/@@theming-controlpanel",
+        "buttons.login": "Se connecter",
+    }
+    response = session.post(url, data=data)
+    return response
+
+
+def get_cookie(response: requests.Response) -> requests.cookies.RequestsCookieJar:
+    return response.cookies
+
+
+def get_token(response: requests.Response) -> str:
+    soup = BeautifulSoup(response.text, "html.parser")
+    authenticator = soup.find(attrs={"name": "_authenticator"})
+    return authenticator["value"]
+
+
+def upload_theme(
+    session: requests.Session,
+    instance_url: str,
+    token: str,
+    theme_path: str,
+    theme_filename: str,
+) -> requests.Response:
+    url = instance_url + "/@@theming-controlpanel"
+    with open(f"{theme_path}/{theme_filename}", "rb") as file_content:
+        file = {"themeArchive": (theme_filename, file_content, "application/zip")}
+        data = {
+            "replaceExisting:boolean": "1",
+            "form.button.Import": "1",
+            "enableNewTheme:boolean": "1",
+            "_authenticator": token,
+        }
+        response = session.post(url, files=file, data=data)
+    return response
+
+
+def main():
+    session = requests.Session()
+    print("Authenticating to Plone instance...")
+    response = authenticate(session, INSTANCE_URL, USERNAME, PASSWORD)
+    if "__ac=deleted" in response.headers["set-cookie"]:
+        print("Authentication failed")
+        sys.exit(1)
+    print("Getting token...")
+    token = get_token(response)
+    print("Uploading theme...")
+    response = upload_theme(session, INSTANCE_URL, token, THEME_PATH, THEME_FILENAME)
+    if response.status_code == 200:
+        print("Theme uploaded successfully")
+    else:
+        print("Theme upload failed... Error code: ", response.status_code)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()