Add lint CI for Python samples (#1083)

Author: jhuleatt

.github/workflows/test_python.yml

@@ -0,0 +1,48 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: CI Tests
+
+on:
+  pull_request:
+    paths:
+      - 'Python/**'
+
+  push:
+    paths:
+      - 'Python/**'
+
+env:
+  CI: true
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+            python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        working-directory: ./Python
+        run: pip install -r requirements.txt
+      - name: Lint
+        working-directory: ./Python
+        run: black . --exclude=venv --check --diff

Python/.gitignore

@@ -0,0 +1 @@
+venv

Python/.style.yapf

@@ -21,15 +21,17 @@
     crashlytics_fn,
     performance_fn,
 )
+
 # [END v2import]
 
 import requests
 
 DISCORD_WEBHOOK_URL = params.SecretParam("DISCORD_WEBHOOK_URL")
 
 
-def post_message_to_discord(bot_name: str, message_body: str,
-                            webhook_url: str) -> requests.Response:
+def post_message_to_discord(
+    bot_name: str, message_body: str, webhook_url: str
+) -> requests.Response:
     """Posts a message to Discord with Discord's Webhook API.
 
     Params:
@@ -58,9 +60,10 @@ def post_message_to_discord(bot_name: str, message_body: str,
 # [START v2CrashlyticsAlertTrigger]
 @crashlytics_fn.on_new_fatal_issue_published(secrets=["DISCORD_WEBHOOK_URL"])
 def post_fatal_issue_to_discord(
-        event: crashlytics_fn.CrashlyticsNewFatalIssueEvent) -> None:
+    event: crashlytics_fn.CrashlyticsNewFatalIssueEvent,
+) -> None:
     """Publishes a message to Discord whenever a new Crashlytics fatal issue occurs."""
-# [END v2CrashlyticsAlertTrigger]
+    # [END v2CrashlyticsAlertTrigger]
     # [START v2CrashlyticsEventPayload]
     # Construct a helpful message to send to Discord.
     app_id = event.app_id
@@ -78,8 +81,9 @@ def post_fatal_issue_to_discord(
 
     try:
         # [START v2SendToDiscord]
-        response = post_message_to_discord("Crashlytics Bot", message,
-                                           DISCORD_WEBHOOK_URL.value())
+        response = post_message_to_discord(
+            "Crashlytics Bot", message, DISCORD_WEBHOOK_URL.value()
+        )
         if response.ok:
             print(
                 f"Posted fatal Crashlytics alert {issue.id} for {app_id} to Discord."
@@ -97,11 +101,13 @@ def post_fatal_issue_to_discord(
 
 # [START v2AppDistributionAlertTrigger]
 @app_distribution_fn.on_new_tester_ios_device_published(
-    secrets=["DISCORD_WEBHOOK_URL"])
+    secrets=["DISCORD_WEBHOOK_URL"]
+)
 def post_new_udid_to_discord(
-        event: app_distribution_fn.NewTesterDeviceEvent) -> None:
+    event: app_distribution_fn.NewTesterDeviceEvent,
+) -> None:
     """Publishes a message to Discord whenever someone registers a new iOS test device."""
-# [END v2AppDistributionAlertTrigger]
+    # [END v2AppDistributionAlertTrigger]
     # [START v2AppDistributionEventPayload]
     # Construct a helpful message to send to Discord.
     app_id = event.app_id
@@ -115,8 +121,9 @@ def post_new_udid_to_discord(
 
     try:
         # [START v2SendNewTesterIosDeviceToDiscord]
-        response = post_message_to_discord("App Distro Bot", message,
-                                           DISCORD_WEBHOOK_URL.value())
+        response = post_message_to_discord(
+            "App Distro Bot", message, DISCORD_WEBHOOK_URL.value()
+        )
         if response.ok:
             print(
                 f"Posted iOS device registration alert for {app_dist.tester_email} to Discord."
@@ -135,9 +142,10 @@ def post_new_udid_to_discord(
 # [START v2PerformanceAlertTrigger]
 @performance_fn.on_threshold_alert_published(secrets=["DISCORD_WEBHOOK_URL"])
 def post_performance_alert_to_discord(
-        event: performance_fn.PerformanceThresholdAlertEvent) -> None:
+    event: performance_fn.PerformanceThresholdAlertEvent,
+) -> None:
     """Publishes a message to Discord whenever a performance threshold alert is fired."""
-# [END v2PerformanceAlertTrigger]
+    # [END v2PerformanceAlertTrigger]
     # [START v2PerformanceEventPayload]
     # Construct a helpful message to send to Discord.
     app_id = event.app_id
@@ -159,8 +167,9 @@ def post_performance_alert_to_discord(
 
     try:
         # [START v2SendPerformanceAlertToDiscord]
-        response = post_message_to_discord("App Performance Bot", message,
-                                           DISCORD_WEBHOOK_URL.value())
+        response = post_message_to_discord(
+            "App Performance Bot", message, DISCORD_WEBHOOK_URL.value()
+        )
         if response.ok:
             print(
                 f"Posted Firebase Performance alert {perf.event_name} to Discord."
@@ -174,4 +183,6 @@ def post_performance_alert_to_discord(
             f"Unable to post Firebase Performance alert {perf.event_name} to Discord.",
             error,
         )
+
+
 # [END v2Alerts]

Python/alerts-to-discord/main.py

@@ -42,6 +42,8 @@ def accountcleanup(event: scheduler_fn.ScheduledEvent) -> None:
         ]
         auth.delete_users(inactive_uids)
         user_page = user_page.get_next_page()
+
+
 # [END accountcleanup]
 
 
@@ -57,4 +59,6 @@ def is_inactive(user: auth.UserRecord, inactive_limit: timedelta) -> bool:
     last_seen = datetime.fromtimestamp(last_seen_timestamp)
     inactive_time = datetime.now() - last_seen
     return inactive_time >= inactive_limit
+
+
 # [END all]

Python/delete-unused-accounts-cron/main.py

@@ -22,6 +22,7 @@
 
 # Build multiple CRUD interfaces:
 
+
 @app.get("/widgets")
 @app.get("/widgets/<id>")
 def get_widget(id=None):
@@ -30,16 +31,21 @@ def get_widget(id=None):
     else:
         return db.reference("/widgets").get()
 
+
 @app.post("/widgets")
 def add_widget():
     new_widget = flask.request.get_data(as_text=True)
     db.reference("/widgets").push(new_widget)
     return flask.Response(status=201, response="Added widget")
 
+
 # Expose Flask app as a single Cloud Function:
 
+
 @https_fn.on_request()
 def httpsflaskexample(req: https_fn.Request) -> https_fn.Response:
     with app.request_context(req.environ):
         return app.full_dispatch_request()
+
+
 # [END httpflaskexample]

Python/http-flask/main.py

@@ -41,12 +41,21 @@ def savegoogletoken(
 
     https://console.firebase.google.com/project/_/authentication/settings
     """
-    if event.credential is not None and event.credential.provider_id == "google.com":
-        print(f"Signed in with {event.credential.provider_id}. Saving access token.")
-    
+    if (
+        event.credential is not None
+        and event.credential.provider_id == "google.com"
+    ):
+        print(
+            f"Signed in with {event.credential.provider_id}. Saving access token."
+        )
+
         firestore_client: google.cloud.firestore.Client = firestore.client()
-        doc_ref = firestore_client.collection("user_info").document(event.data.uid)
-        doc_ref.set({"calendar_access_token": event.credential.access_token}, merge=True)
+        doc_ref = firestore_client.collection("user_info").document(
+            event.data.uid
+        )
+        doc_ref.set(
+            {"calendar_access_token": event.credential.access_token}, merge=True
+        )
 
         tasks_client = google.cloud.tasks_v2.CloudTasksClient()
         task_queue = tasks_client.queue_path(
@@ -65,14 +74,16 @@ def savegoogletoken(
             schedule_time=datetime.now() + timedelta(minutes=1),
         )
         tasks_client.create_task(parent=task_queue, task=calendar_task)
+
+
 # [END savegoogletoken]
 
 
 # [START scheduleonboarding]
 @tasks_fn.on_task_dispatched()
 def scheduleonboarding(request: tasks_fn.CallableRequest) -> https_fn.Response:
     """Add an onboarding event to a user's Google Calendar.
-    
+
     Retrieves and deletes the access token that was saved to Cloud Firestore.
     """
 
@@ -91,18 +102,22 @@ def scheduleonboarding(request: tasks_fn.CallableRequest) -> https_fn.Response:
         )
 
     firestore_client: google.cloud.firestore.Client = firestore.client()
-    user_info = firestore_client.collection("user_info").document(uid).get().to_dict()
+    user_info = (
+        firestore_client.collection("user_info").document(uid).get().to_dict()
+    )
     if "calendar_access_token" not in user_info:
         return https_fn.Response(
             status=https_fn.FunctionsErrorCode.PERMISSION_DENIED,
             response="No Google OAuth token found.",
         )
     calendar_access_token = user_info["calendar_access_token"]
-    firestore_client.collection("user_info").document(uid).update({
-        "calendar_access_token": google.cloud.firestore.DELETE_FIELD
-    })
+    firestore_client.collection("user_info").document(uid).update(
+        {"calendar_access_token": google.cloud.firestore.DELETE_FIELD}
+    )
 
-    google_credentials = google.oauth2.credentials.Credentials(token=calendar_access_token)
+    google_credentials = google.oauth2.credentials.Credentials(
+        token=calendar_access_token
+    )
 
     calendar_client = googleapiclient.discovery.build(
         "calendar", "v3", credentials=google_credentials
@@ -116,15 +131,21 @@ def scheduleonboarding(request: tasks_fn.CallableRequest) -> https_fn.Response:
             "timeZone": "America/Los_Angeles",
         },
         "end": {
-            "dateTime": (datetime.now() + timedelta(days=3, hours=1)).isoformat(),
+            "dateTime": (
+                datetime.now() + timedelta(days=3, hours=1)
+            ).isoformat(),
             "timeZone": "America/Los_Angeles",
         },
         "attendees": [
             {"email": user_record.email},
             {"email": "[email protected]"},
         ],
     }
-    calendar_client.events().insert(calendarId="primary", body=calendar_event).execute()
+    calendar_client.events().insert(
+        calendarId="primary", body=calendar_event
+    ).execute()
+
+
 # [END scheduleonboarding]
 
 
@@ -143,7 +164,9 @@ def get_function_url(
     credentials, project_id = google.auth.default(
         scopes=["https://www.googleapis.com/auth/cloud-platform"]
     )
-    authed_session = google.auth.transport.requests.AuthorizedSession(credentials)
+    authed_session = google.auth.transport.requests.AuthorizedSession(
+        credentials
+    )
     url = (
         "https://cloudfunctions.googleapis.com/v2beta/"
         + f"projects/{project_id}/locations/{location}/functions/{name}"

Python/post-signup-event/main.py

@@ -0,0 +1,21 @@
+# Copyright 2023 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+[project]
+name = "functions_samples"
+version = "1.0.0"
+[tool.black]
+line-length = 80
+[tool.mypy]
+python_version = "3.10"