openfaas/openfaas-cloud

Reliability monitoring - e2e testing of GitHub workflow

Open

#403 opened on Feb 22, 2019

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Go (222 forks)auto 404
good first issuehelp wantedsize/lskill/intermediate

Repository metrics

Stars
 (770 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Reliability monitoring - e2e testing of GitHub workflow

Context

Since moving the Communtity Cluster from GKE to DigitalOcean the reliability has dropped dramatically due to issues with the Cilium networking driver 1.4.0. A separate action will be required for this, but in the meantime it highlights a lack of e2e monitoring for the GitHub workflow end-to-end.

Task

Create a Golang function that will:

  • clone the repo (it will be a Go function)
  • modify the handler's response to include a specific string such as the current date/time stamp
  • do a git push (using a secret)
  • call the function in a loop with a generous timeout until the response contains the new string
  • call into a slack webhook if the string is incorrect or not 200 at the end

Constraints

  • The repo in question should be cloned with the go-github library
  • This should be an OpenFaaS function
  • Use /tmp/ as a writable area
  • For write access use the GitHub App approach as per alexellis/derek and openfaas/openfaas-cloud

Suggestions and input is welcome

Contributor guide

Research direction
Implement a Go function using the go github library to clone the repo, modify a handler response with a timestamp, push using GitHub App authentication, poll the endpoint until the new string appears, and notify Slack on failure.
Tech stack
gogithub actions
Domain
backenddevopstesting
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGitOpenFaaS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60