github_incoming.go 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  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. // create deployment on GitHub API
  66. client, err := getGithubClientFromEnvironment(c.Config(), env)
  67. if err != nil {
  68. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d] error getting github client: %w",
  69. webhookID, owner, repo, env.ID, err)
  70. }
  71. if env.Mode == "auto" && event.GetAction() == "opened" {
  72. _, err := client.Actions.CreateWorkflowDispatchEventByFileName(
  73. r.Context(), owner, repo, fmt.Sprintf("porter_%s_env.yml", env.Name),
  74. github.CreateWorkflowDispatchEventRequest{
  75. Ref: event.PullRequest.GetHead().GetRef(),
  76. Inputs: map[string]interface{}{
  77. "pr_number": strconv.FormatUint(uint64(event.PullRequest.GetNumber()), 10),
  78. "pr_title": event.PullRequest.GetTitle(),
  79. "pr_branch_from": event.PullRequest.GetHead().GetRef(),
  80. "pr_branch_into": event.PullRequest.GetBase().GetRef(),
  81. },
  82. },
  83. )
  84. if err != nil {
  85. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d] error creating workflow dispatch event: %w",
  86. webhookID, owner, repo, env.ID, err)
  87. }
  88. } else if event.GetAction() == "synchronize" || event.GetAction() == "closed" {
  89. depl, err := c.Repo().Environment().ReadDeploymentByGitDetails(
  90. env.ID, owner, repo, uint(event.GetPullRequest().GetNumber()),
  91. )
  92. if err != nil {
  93. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d] error reading deployment: %w",
  94. webhookID, owner, repo, env.ID, err)
  95. }
  96. if depl.Status != types.DeploymentStatusInactive {
  97. if event.GetAction() == "synchronize" {
  98. _, err := client.Actions.CreateWorkflowDispatchEventByFileName(
  99. r.Context(), owner, repo, fmt.Sprintf("porter_%s_env.yml", env.Name),
  100. github.CreateWorkflowDispatchEventRequest{
  101. Ref: event.PullRequest.GetHead().GetRef(),
  102. Inputs: map[string]interface{}{
  103. "pr_number": strconv.FormatUint(uint64(event.PullRequest.GetNumber()), 10),
  104. "pr_title": event.PullRequest.GetTitle(),
  105. "pr_branch_from": event.PullRequest.GetHead().GetRef(),
  106. "pr_branch_into": event.PullRequest.GetBase().GetRef(),
  107. },
  108. },
  109. )
  110. if err != nil {
  111. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, deploymentID: %d] error creating workflow dispatch event: %w",
  112. webhookID, owner, repo, env.ID, depl.ID, err)
  113. }
  114. } else {
  115. err = c.deleteDeployment(r, depl, env, client)
  116. if err != nil {
  117. return fmt.Errorf("[webhookID: %s, owner: %s, repo: %s, environmentID: %d, deploymentID: %d] error deleting deployment: %w",
  118. webhookID, owner, repo, env.ID, depl.ID, err)
  119. }
  120. }
  121. }
  122. }
  123. return nil
  124. }
  125. func (c *GithubIncomingWebhookHandler) deleteDeployment(
  126. r *http.Request,
  127. depl *models.Deployment,
  128. env *models.Environment,
  129. client *github.Client,
  130. ) error {
  131. cluster, err := c.Repo().Cluster().ReadCluster(env.ProjectID, env.ClusterID)
  132. if err != nil {
  133. return fmt.Errorf("[projectID: %d, clusterID: %d] error reading cluster: %w", env.ProjectID, env.ClusterID, err)
  134. }
  135. agent, err := c.GetAgent(r, cluster, "")
  136. if err != nil {
  137. return err
  138. }
  139. // make sure we don't delete default or kube-system by checking for prefix, for now
  140. if strings.Contains(depl.Namespace, "pr-") {
  141. err = agent.DeleteNamespace(depl.Namespace)
  142. if err != nil {
  143. return fmt.Errorf("[owner: %s, repo: %s, environmentID: %d, deploymentID: %d] error deleting namespace '%s': %w",
  144. env.GitRepoOwner, env.GitRepoName, env.ID, depl.ID, depl.Namespace, err)
  145. }
  146. }
  147. // Create new deployment status to indicate deployment is ready
  148. state := "inactive"
  149. deploymentStatusRequest := github.DeploymentStatusRequest{
  150. State: &state,
  151. }
  152. client.Repositories.CreateDeploymentStatus(
  153. context.Background(),
  154. env.GitRepoOwner,
  155. env.GitRepoName,
  156. depl.GHDeploymentID,
  157. &deploymentStatusRequest,
  158. )
  159. depl.Status = types.DeploymentStatusInactive
  160. // update the deployment to mark it inactive
  161. _, err = c.Repo().Environment().UpdateDeployment(depl)
  162. if err != nil {
  163. return fmt.Errorf("[owner: %s, repo: %s, environmentID: %d, deploymentID: %d] error updating deployment: %w",
  164. env.GitRepoOwner, env.GitRepoName, env.ID, depl.ID, err)
  165. }
  166. return nil
  167. }
  168. func getGithubClientFromEnvironment(config *config.Config, env *models.Environment) (*github.Client, error) {
  169. // get the github app client
  170. ghAppId, err := strconv.Atoi(config.ServerConf.GithubAppID)
  171. if err != nil {
  172. return nil, err
  173. }
  174. // authenticate as github app installation
  175. itr, err := ghinstallation.NewKeyFromFile(
  176. http.DefaultTransport,
  177. int64(ghAppId),
  178. int64(env.GitInstallationID),
  179. config.ServerConf.GithubAppSecretPath,
  180. )
  181. if err != nil {
  182. return nil, err
  183. }
  184. return github.NewClient(&http.Client{Transport: itr}), nil
  185. }