Joint-Teapot/joint_teapot/workers/mattermost.py
Salty Fish d437cb8b18
feat: basic Mattermost integration functionality (#10)
* Fix small error in venv setup guide

* Add functions for mm integration

Implemented: create channels for groups
Implemented: create webhooks on both sides for groups
As for now these functions can only be called from the Python REPL

* Add commands for mm channel/webhook creation

Implemented: archive a given list of channels (unused)

* Add new features to README

* Add filter argument for channel/webhook creation

This filter argument is optional and defaults to an empty string,
meaning no filtering is required. This is helpful for excluding previous
project repos or irrelevant repos.
Also added detection logic to handle an exception where a student is on
MM but not in the target team. (Perhaps we would want to invite that
student immediately?)

* Update README

Clarify platform difference for venv
Restructure Commands & Features section to make room for better docs

* Remove unused function from Canvas worker

* Add gitea domain name and suffix config items

Align with the mm worker, and grant more flexibility
Also changed terminology to be clearer (`domain_name` instead of `url`)

* Code style and quality updates

* Add domain name and suffix config items for Canvas

* Return to using dicts to represent groups

Removed `StudentGroup` at BoYanZh's request
2022-05-27 12:10:08 +08:00

151 lines
6.1 KiB
Python

from typing import Dict, List, Union
import focs_gitea
from mattermostdriver import Driver
from joint_teapot.config import settings
from joint_teapot.utils.logger import logger
from joint_teapot.workers.gitea import Gitea
class Mattermost:
def __init__(
self,
access_token: str = settings.mattermost_access_token,
team_name: str = settings.mattermost_team,
domain_name: str = settings.mattermost_domain_name,
suffix: str = settings.mattermost_suffix,
):
self.url = domain_name
self.url_suffix = suffix
self.endpoint = Driver(
{
"url": domain_name,
"port": 443,
"basepath": suffix + "/api/v4",
"token": access_token,
}
)
try:
operator = self.endpoint.login()
except Exception:
logger.error("Cannot login to Mattermost")
return
if "admin" not in operator["roles"]:
logger.error("Please make sure you have enough permission")
try:
self.team = self.endpoint.teams.get_team_by_name(team_name)
except Exception as e:
logger.error(f"Cannot get team {team_name}: {e}")
return
def create_channels_for_groups(
self, groups: List[Dict[str, Union[str, List[str]]]]
) -> None:
for group in groups:
try:
channel = self.endpoint.channels.create_channel(
{
"team_id": self.team["id"],
"name": group["name"],
"display_name": group["name"],
"type": "P", # create private channels
}
)
logger.info(f"Added group {group['name']} to Mattermost")
except Exception as e:
logger.warning(
f"Error when creating channel {group['name']}: {e} Perhaps channel already exists?"
)
continue
for member in group["members"]:
try:
mmuser = self.endpoint.users.get_user_by_username(member)
except Exception:
logger.warning(
f"User {member} is not found on the Mattermost server"
)
continue
# code for adding student to mm, disabled since there is no need to do that
# try:
# mmuser = self.endpoint.users.create_user({'email':f"{member}@sjtu.edu.cn", 'username':member, auth_service:"gitlab"})
# except e:
# logger.error(f"Error creating user {member}")
# continue
try:
self.endpoint.channels.add_user(
channel["id"], {"user_id": mmuser["id"]}
)
except Exception:
logger.warning(f"User {member} is not in the team")
logger.info(f"Added member {member} to channel {group['name']}")
def create_webhooks_for_repos(self, repos: List[str], gitea: Gitea) -> None:
# one group corresponds to one repo so these concepts can be used interchangably
for repo in repos:
logger.info(f"Creating webhooks for repo {gitea.org_name}/{repo}")
try:
mm_channel = self.endpoint.channels.get_channel_by_name(
self.team["id"], repo
)
except Exception as e:
logger.warning(
f"Error when getting channel {repo} from Mattermost team {self.team['name']}: {e}"
)
continue
try:
mm_webhook = self.endpoint.webhooks.create_incoming_hook(
{
"channel_id": mm_channel["id"],
"display_name": f"Gitea integration for {self.team['name']}/{repo}",
"channel_locked": True,
}
)
except Exception as e:
logger.error(f"Error when creating incoming webhook at Mattermost: {e}")
continue
try:
gitea.repository_api.repo_create_hook(
gitea.org_name,
repo,
body=focs_gitea.CreateHookOption(
active=True,
type="slack",
events=[
"create",
"delete",
"push",
"release",
"issues_only",
"issue_assign",
"issue_comment",
"pull_request_only",
"pull_request_assign",
"pull_request_comment",
"pull_request_review",
],
config={
"url": f"https://{self.url}{self.url_suffix}/hooks/{mm_webhook['id']}",
"username": "FOCS Gitea",
"icon_url": f"https://{self.url}{self.url_suffix}/api/v4/brand/image",
"content_type": "json",
"channel": repo,
},
),
)
except Exception as e:
logger.warning(f"Error when creating outgoing webhook at Gitea: {e}")
# unused since we can give students invitation links instead
def invite_students_to_team(self, students: List[str]) -> None:
for student in students:
try:
mmuser = self.endpoint.users.get_user_by_username(student)
except Exception:
logger.warning(f"User {student} is not found on the Mattermost server")
continue
self.endpoint.teams.add_user_to_team(
self.team["id"], {"user_id": mmuser["id"], "team_id": self.team["id"]}
)
logger.info(f"Added user {student} to team {self.team['name']}")