github_incoming.go 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. package webhook
  2. import (
  3. "context"
  4. "fmt"
  5. "net/http"
  6. "strconv"
  7. "strings"
  8. "github.com/bradleyfalzon/ghinstallation/v2"
  9. "github.com/google/go-github/v41/github"
  10. "github.com/porter-dev/porter/api/server/authz"
  11. "github.com/porter-dev/porter/api/server/handlers"
  12. "github.com/porter-dev/porter/api/server/shared"
  13. "github.com/porter-dev/porter/api/server/shared/apierrors"
  14. "github.com/porter-dev/porter/api/server/shared/config"
  15. "github.com/porter-dev/porter/api/server/shared/requestutils"
  16. "github.com/porter-dev/porter/api/types"
  17. "github.com/porter-dev/porter/internal/models"
  18. )
  19. type GithubIncomingWebhookHandler struct {
  20. handlers.PorterHandlerReadWriter
  21. authz.KubernetesAgentGetter
  22. }
  23. func NewGithubIncomingWebhookHandler(
  24. config *config.Config,
  25. decoderValidator shared.RequestDecoderValidator,
  26. writer shared.ResultWriter,
  27. ) *GithubIncomingWebhookHandler {
  28. return &GithubIncomingWebhookHandler{
  29. PorterHandlerReadWriter: handlers.NewDefaultPorterHandler(config, decoderValidator, writer),
  30. KubernetesAgentGetter: authz.NewOutOfClusterAgentGetter(config),
  31. }
  32. }
  33. func (c *GithubIncomingWebhookHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  34. payload, err := github.ValidatePayload(r, []byte(c.Config().ServerConf.GithubIncomingWebhookSecret))
  35. if err != nil {
  36. c.HandleAPIError(w, r, apierrors.NewErrInternal(fmt.Errorf("error validating webhook payload: %w", err)))
  37. return
  38. }
  39. event, err := github.ParseWebHook(github.WebHookType(r), payload)
  40. if err != nil {
  41. c.HandleAPIError(w, r, apierrors.NewErrInternal(fmt.Errorf("error parsing webhook: %w", err)))
  42. return
  43. }
  44. switch event := event.(type) {
  45. case *github.PullRequestEvent:
  46. err = c.processPullRequestEvent(event, r)
  47. if err != nil {
  48. c.HandleAPIError(w, r, apierrors.NewErrInternal(fmt.Errorf("error processing pull request webhook event: %w", err)))
  49. return
  50. }
  51. }
  52. }
  53. func (c *GithubIncomingWebhookHandler) processPullRequestEvent(event *github.PullRequestEvent, r *http.Request) error {
  54. // get the webhook id from the request
  55. webhookID, reqErr := requestutils.GetURLParamString(r, types.URLParamIncomingWebhookID)
  56. if reqErr != nil {
  57. return fmt.Errorf(reqErr.Error())
  58. }
  59. owner := event.GetRepo().GetOwner().GetLogin()
  60. repo := event.GetRepo().GetName()
  61. env, err := c.Repo().Environment().ReadEnvironmentByWebhookIDOwnerRepoName(webhookID, owner, repo)
  62. if err != nil {
  63. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s] error reading environment: %w", webhookID, owner, repo, err)
  64. }
  65. if event.PullRequest == nil {
  66. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s] incoming webhook does not have pull request information: %w",
  67. webhookID, owner, repo, err)
  68. }
  69. // create deployment on GitHub API
  70. client, err := getGithubClientFromEnvironment(c.Config(), env)
  71. if err != nil {
  72. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, prNumber: %d] "+
  73. "error getting github client: %w", webhookID, owner, repo, env.ID, event.PullRequest.GetNumber(), err)
  74. }
  75. if env.Mode == "auto" && event.GetAction() == "opened" {
  76. _, err := client.Actions.CreateWorkflowDispatchEventByFileName(
  77. r.Context(), owner, repo, fmt.Sprintf("porter_%s_env.yml", env.Name),
  78. github.CreateWorkflowDispatchEventRequest{
  79. Ref: event.PullRequest.GetHead().GetRef(),
  80. Inputs: map[string]interface{}{
  81. "pr_number": strconv.FormatUint(uint64(event.PullRequest.GetNumber()), 10),
  82. "pr_title": event.PullRequest.GetTitle(),
  83. "pr_branch_from": event.PullRequest.GetHead().GetRef(),
  84. "pr_branch_into": event.PullRequest.GetBase().GetRef(),
  85. },
  86. },
  87. )
  88. if err != nil {
  89. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, prNumber: %d] "+
  90. "error creating workflow dispatch event: %w", webhookID, owner, repo, env.ID, event.PullRequest.GetNumber(), err)
  91. }
  92. } else if event.GetAction() == "synchronize" || event.GetAction() == "closed" {
  93. depl, err := c.Repo().Environment().ReadDeploymentByGitDetails(
  94. env.ID, owner, repo, uint(event.GetPullRequest().GetNumber()),
  95. )
  96. if err != nil {
  97. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, prNumber: %d] "+
  98. "error reading deployment: %w", webhookID, owner, repo, env.ID, event.PullRequest.GetNumber(), err)
  99. }
  100. if depl.Status == types.DeploymentStatusInactive {
  101. return nil
  102. }
  103. if event.GetAction() == "synchronize" {
  104. _, err := client.Actions.CreateWorkflowDispatchEventByFileName(
  105. r.Context(), owner, repo, fmt.Sprintf("porter_%s_env.yml", env.Name),
  106. github.CreateWorkflowDispatchEventRequest{
  107. Ref: event.PullRequest.GetHead().GetRef(),
  108. Inputs: map[string]interface{}{
  109. "pr_number": strconv.FormatUint(uint64(event.PullRequest.GetNumber()), 10),
  110. "pr_title": event.PullRequest.GetTitle(),
  111. "pr_branch_from": event.PullRequest.GetHead().GetRef(),
  112. "pr_branch_into": event.PullRequest.GetBase().GetRef(),
  113. },
  114. },
  115. )
  116. if err != nil {
  117. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, deploymentID: %d, prNumber: %d] "+
  118. "error creating workflow dispatch event: %w", webhookID, owner, repo, env.ID, depl.ID,
  119. event.PullRequest.GetNumber(), err)
  120. }
  121. } else {
  122. err = c.deleteDeployment(r, depl, env, client)
  123. if err != nil {
  124. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, deploymentID: %d, prNumber: %d] "+
  125. "error deleting deployment: %w", webhookID, owner, repo, env.ID, depl.ID,
  126. event.PullRequest.GetNumber(), err)
  127. }
  128. }
  129. }
  130. return nil
  131. }
  132. func (c *GithubIncomingWebhookHandler) deleteDeployment(
  133. r *http.Request,
  134. depl *models.Deployment,
  135. env *models.Environment,
  136. client *github.Client,
  137. ) error {
  138. cluster, err := c.Repo().Cluster().ReadCluster(env.ProjectID, env.ClusterID)
  139. if err != nil {
  140. return fmt.Errorf("[projectID: %d, clusterID: %d] error reading cluster: %w", env.ProjectID, env.ClusterID, err)
  141. }
  142. agent, err := c.GetAgent(r, cluster, "")
  143. if err != nil {
  144. return err
  145. }
  146. // make sure we don't delete default or kube-system by checking for prefix, for now
  147. if strings.Contains(depl.Namespace, "pr-") {
  148. err = agent.DeleteNamespace(depl.Namespace)
  149. if err != nil {
  150. return fmt.Errorf("[owner: %s, repo: %s, environmentID: %d, deploymentID: %d] error deleting namespace '%s': %w",
  151. env.GitRepoOwner, env.GitRepoName, env.ID, depl.ID, depl.Namespace, err)
  152. }
  153. }
  154. // Create new deployment status to indicate deployment is ready
  155. state := "inactive"
  156. deploymentStatusRequest := github.DeploymentStatusRequest{
  157. State: &state,
  158. }
  159. client.Repositories.CreateDeploymentStatus(
  160. context.Background(),
  161. env.GitRepoOwner,
  162. env.GitRepoName,
  163. depl.GHDeploymentID,
  164. &deploymentStatusRequest,
  165. )
  166. depl.Status = types.DeploymentStatusInactive
  167. // update the deployment to mark it inactive
  168. _, err = c.Repo().Environment().UpdateDeployment(depl)
  169. if err != nil {
  170. return fmt.Errorf("[owner: %s, repo: %s, environmentID: %d, deploymentID: %d] error updating deployment: %w",
  171. env.GitRepoOwner, env.GitRepoName, env.ID, depl.ID, err)
  172. }
  173. return nil
  174. }
  175. func getGithubClientFromEnvironment(config *config.Config, env *models.Environment) (*github.Client, error) {
  176. // get the github app client
  177. ghAppId, err := strconv.Atoi(config.ServerConf.GithubAppID)
  178. if err != nil {
  179. return nil, err
  180. }
  181. // authenticate as github app installation
  182. itr, err := ghinstallation.NewKeyFromFile(
  183. http.DefaultTransport,
  184. int64(ghAppId),
  185. int64(env.GitInstallationID),
  186. config.ServerConf.GithubAppSecretPath,
  187. )
  188. if err != nil {
  189. return nil, err
  190. }
  191. return github.NewClient(&http.Client{Transport: itr}), nil
  192. }