cmem-plugin-mattermost

Send messages to Mattermost channels and users.

Development

• Run task to see all major development tasks.
• Use pre-commit to avoid errors before commit.
• This repository was created with this copier template.

Plugin Usage

This plugin allows sending messages, to channels or/and users via a defined bot, in Mattermost.

The plugin can be used as a workflow plugin. For execution, it needs the url of the own mattermost server, an access token and the display name or name of the bot that should send the messages.

Parameters

Parameter	Description
url	The URL of the Mattermost server to which the plugin should connect.
access_token	The access token of the bot that will be used to send the messages.
bot_name	The display name or name of the bot used to send the messages.
user	The full name, username, nickname, or email address of the user(s) who will receive the message. If the message is to be sent to multiple users, separate them with a comma ","
channel	The name or display name of the channel(s) to which the message is to be sent. If the message is to be sent to multiple channels, separate them with a comma ","
message	The message to be sent.

Execution

This plugin enables users to send messages either statically or dynamically via entities. For static messages, users and channels must be pre-configured to receive the message. For dynamic messages, input for user, channel, and message can be passed in as entities during workflow execution. Messages can be sent to specified users or channels every time the workflow is executed.

Running Test

To run a mattermost orchestration locally, you can use task:

task custom:mattermost:start
task custom:mattermost:db:load

On PyCharm

If you want to use single test run pytest have to be configured. Set the working directory under following path, to the one who the repository is on your local machine.

Edit Configuration -> Edit Configuration Templates -> Python Test -> Autodetect -> Working Directory

If you want to run a local test environment with cmem-orchestration you have to connect the Docker container in one network.

docker network connect dockerlocalhost_default docker_mattermost_1

docker network inspect dockerlocalhost_default

To set the URL parameter, copy the IP address of the docker_mattermost_1 container and append :8065 to the end. This will create the appropriate URL for accessing Mattermost on the local environment.

Mattermost Test Environment

Bot-account

Name:           "plugin-test"
Access-token:   <bot-access-token>

Admin account

Name:       "cmempy-developer" 
Password:   "cmempy-developer" 
Email:      "cmempy-developer@eccenca.com" 
User ID :   "hruniqwds7gg5bcm5fmn931iih"

User accounts

Name:       "user0example" 
Password:   "Password0" 
Email:      "user0@example.com" 
User ID :   "r3qsjphq97fatecdtye9kmeijw"

Name:       "user1example"
Password:   "Password1"
Email:      "user0@example.com"
User ID :   "36itfo66b7dyxc9x9nec4pssoc"

Name:       "user2example"
Password:   "Password2"
Email:      "user2@example.com"
Firstname:  "User"
Lastname:   "Eample2" 
Nickname:   "userex2" 
User-ID :   "z85twbta8b8bpe3qaf7n3iecwa"

Name:       "user3example"
Password:   "Password3"
Email:      "user3@example.com"
Firstname:  "User"
Lastname:   "Eample3"
Nickname:   "userex3"
User-ID :   "3j4wossgfirburd63ftd5mq16c"

To make and save custom settings, as well as start and close the Docker container, the following task commands are available:

task commands	description
mattermost:db:dump	Dump the mattermost database to volume/db.sql
mattermost:db:load	Load the mattermost database from volume/db.sql
mattermost:start	Start or restart the mattermost orchestration
mattermost:stop	Stop the mattermost orchestration