|
| 1 | +// Copyright The Linux Foundation and each contributor to CommunityBridge. |
| 2 | +// SPDX-License-Identifier: MIT |
| 3 | + |
| 4 | +package github |
| 5 | + |
| 6 | +import ( |
| 7 | + "fmt" |
| 8 | + "github.com/linuxfoundation/easycla/cla-backend-go/events" |
| 9 | + "github.com/linuxfoundation/easycla/cla-backend-go/gen/v1/models" |
| 10 | + log "github.com/linuxfoundation/easycla/cla-backend-go/logging" |
| 11 | + "github.com/sirupsen/logrus" |
| 12 | + "regexp" |
| 13 | + "strings" |
| 14 | +) |
| 15 | + |
| 16 | +// propertyMatches returns true if value matches the pattern. |
| 17 | +// - "*" matches anything |
| 18 | +// - "re:..." matches regex (value must be non-empty) |
| 19 | +// - otherwise, exact match |
| 20 | +func propertyMatches(pattern, value string) bool { |
| 21 | + f := logrus.Fields{ |
| 22 | + "functionName": "github.propertyMatches", |
| 23 | + "pattern": pattern, |
| 24 | + "value": value, |
| 25 | + } |
| 26 | + if pattern == "*" { |
| 27 | + return true |
| 28 | + } |
| 29 | + if value == "" { |
| 30 | + return false |
| 31 | + } |
| 32 | + if strings.HasPrefix(pattern, "re:") { |
| 33 | + regex := pattern[3:] |
| 34 | + re, err := regexp.Compile(regex) |
| 35 | + if err != nil { |
| 36 | + log.WithFields(f).Debugf("Error in propertyMatches: bad regexp: %s, error: %v", regex, err) |
| 37 | + return false |
| 38 | + } |
| 39 | + return re.MatchString(value) |
| 40 | + } |
| 41 | + return value == pattern |
| 42 | +} |
| 43 | + |
| 44 | +// stripOrg removes the organization part from the repository name. |
| 45 | +// If input is "org/repo", returns "repo". If no "/", returns input unchanged. |
| 46 | +func stripOrg(repoFull string) string { |
| 47 | + idx := strings.Index(repoFull, "/") |
| 48 | + if idx >= 0 && idx+1 < len(repoFull) { |
| 49 | + return repoFull[idx+1:] |
| 50 | + } |
| 51 | + return repoFull |
| 52 | +} |
| 53 | + |
| 54 | +// isActorSkipped returns true if the given actor should be skipped according to the skip_cla config pattern. |
| 55 | +// config format: "<username_pattern>;<email_pattern>" |
| 56 | +// Actor.CommitAuthor.Login and Actor.CommitAuthor.Email should be *string, can be nil. |
| 57 | +func isActorSkipped(actor *UserCommitSummary, config string) bool { |
| 58 | + f := logrus.Fields{ |
| 59 | + "functionName": "github.isActorSkipped", |
| 60 | + "config": config, |
| 61 | + } |
| 62 | + // Defensive: must have exactly one ';' |
| 63 | + if !strings.Contains(config, ";") { |
| 64 | + log.WithFields(f).Debugf("Invalid skip_cla config format: %s, expected '<username_pattern>;<email_pattern>'", config) |
| 65 | + return false |
| 66 | + } |
| 67 | + parts := strings.SplitN(config, ";", 2) |
| 68 | + if len(parts) != 2 { |
| 69 | + return false |
| 70 | + } |
| 71 | + usernamePattern := parts[0] |
| 72 | + emailPattern := parts[1] |
| 73 | + var ( |
| 74 | + username string |
| 75 | + email string |
| 76 | + ) |
| 77 | + if actor.CommitAuthor != nil && actor.CommitAuthor.Login != nil { |
| 78 | + username = *actor.CommitAuthor.Login |
| 79 | + } |
| 80 | + if actor.CommitAuthor != nil && actor.CommitAuthor.Email != nil { |
| 81 | + email = *actor.CommitAuthor.Email |
| 82 | + } |
| 83 | + |
| 84 | + return propertyMatches(usernamePattern, username) && propertyMatches(emailPattern, email) |
| 85 | +} |
| 86 | + |
| 87 | +// SkipWhitelistedBots- check if the actors are whitelisted based on the skip_cla configuration. |
| 88 | +// Returns two lists: |
| 89 | +// - actors still missing cla: actors who still need to sign the CLA after checking skip_cla |
| 90 | +// - whitelisted actors: actors who are skipped due to skip_cla configuration |
| 91 | +// :param orgModel: The GitHub organization model instance. |
| 92 | +// :param orgRepo: The repository name in the format 'org/repo'. |
| 93 | +// :param actorsMissingCla: List of UserCommitSummary objects representing actors who are missing CLA. |
| 94 | +// :return: two arrays (actors still missing CLA, whitelisted actors) |
| 95 | +// : in cla-{stage}-github-orgs table there can be a skip_cla field which is a dict with the following structure: |
| 96 | +// |
| 97 | +// { |
| 98 | +// "repo-name": "<username_pattern>;<email_pattern>", |
| 99 | +// "re:repo-regexp": "<username_pattern>;<email_pattern>", |
| 100 | +// "*": "<username_pattern>;<email_pattern>" |
| 101 | +// } |
| 102 | +// |
| 103 | +// where: |
| 104 | +// - repo-name is the exact repository name under given org (e.g., "my-repo" not "my-org/my-repo") |
| 105 | +// - re:repo-regexp is a regex pattern to match repository names |
| 106 | +// - * is a wildcard that applies to all repositories |
| 107 | +// - <username_pattern> is a GitHub username pattern (exact match or regex prefixed by re: or match all '*') |
| 108 | +// - <email_pattern> is a GitHub email pattern (exact match or regex prefixed by re: or match all '*') |
| 109 | +// The username and email patterns are separated by a semicolon (;). |
| 110 | +// If the skip_cla is not set, it will skip the whitelisted bots check. |
| 111 | +func SkipWhitelistedBots(ev events.Service, orgModel *models.GithubOrganization, orgRepo, projectID string, actorsMissingCLA []*UserCommitSummary) ([]*UserCommitSummary, []*UserCommitSummary) { |
| 112 | + repo := stripOrg(orgRepo) |
| 113 | + f := logrus.Fields{ |
| 114 | + "functionName": "github.SkipWhitelistedBots", |
| 115 | + "orgRepo": orgRepo, |
| 116 | + "repo": repo, |
| 117 | + "projectID": projectID, |
| 118 | + } |
| 119 | + outActorsMissingCLA := []*UserCommitSummary{} |
| 120 | + whitelistedActors := []*UserCommitSummary{} |
| 121 | + |
| 122 | + skipCLA := orgModel.SkipCla |
| 123 | + if skipCLA == nil { |
| 124 | + log.WithFields(f).Debug("skip_cla is not set, skipping whitelisted bots check") |
| 125 | + return actorsMissingCLA, []*UserCommitSummary{} |
| 126 | + } |
| 127 | + |
| 128 | + var config string |
| 129 | + |
| 130 | + // 1. Exact match |
| 131 | + if val, ok := skipCLA[repo]; ok { |
| 132 | + config = val |
| 133 | + log.WithFields(f).Debugf("skip_cla config found for repo (exact hit): '%s'", config) |
| 134 | + } |
| 135 | + |
| 136 | + // 2. Regex match (if no exact hit) |
| 137 | + if config == "" { |
| 138 | + log.WithFields(f).Debug("No skip_cla config found for repo, checking regex patterns") |
| 139 | + for k, v := range skipCLA { |
| 140 | + if !strings.HasPrefix(k, "re:") { |
| 141 | + continue |
| 142 | + } |
| 143 | + pattern := k[3:] |
| 144 | + re, err := regexp.Compile(pattern) |
| 145 | + if err != nil { |
| 146 | + log.WithFields(f).Warnf("Invalid regex in skip_cla: '%s': %+v", pattern, err) |
| 147 | + continue |
| 148 | + } |
| 149 | + if re.MatchString(repo) { |
| 150 | + config = v |
| 151 | + log.WithFields(f).Debugf("Found skip_cla config for repo via regex pattern: '%s'", config) |
| 152 | + break |
| 153 | + } |
| 154 | + } |
| 155 | + } |
| 156 | + |
| 157 | + // 3. Wildcard fallback |
| 158 | + if config == "" { |
| 159 | + if val, ok := skipCLA["*"]; ok { |
| 160 | + config = val |
| 161 | + log.WithFields(f).Debugf("No skip_cla config found for repo, using wildcard config: '%s'", config) |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + // 4. No match |
| 166 | + if config == "" { |
| 167 | + log.WithFields(f).Debug("No skip_cla config found for repo, skipping whitelisted bots check") |
| 168 | + return actorsMissingCLA, []*UserCommitSummary{} |
| 169 | + } |
| 170 | + |
| 171 | + for _, actor := range actorsMissingCLA { |
| 172 | + if isActorSkipped(actor, config) { |
| 173 | + id, login, username, email := "(null)", "(null)", "(null)", "(null)" |
| 174 | + if actor.CommitAuthor != nil && actor.CommitAuthor.ID != nil { |
| 175 | + id = fmt.Sprintf("%v", *actor.CommitAuthor.ID) |
| 176 | + } |
| 177 | + if actor.CommitAuthor != nil && actor.CommitAuthor.Login != nil { |
| 178 | + login = *actor.CommitAuthor.Login |
| 179 | + } |
| 180 | + if actor.CommitAuthor != nil && actor.CommitAuthor.Name != nil { |
| 181 | + username = *actor.CommitAuthor.Name |
| 182 | + } |
| 183 | + if actor.CommitAuthor != nil && actor.CommitAuthor.Email != nil { |
| 184 | + email = *actor.CommitAuthor.Email |
| 185 | + } |
| 186 | + actorData := fmt.Sprintf("id='%v',login='%v',username='%v',email='%v'", id, login, username, email) |
| 187 | + msg := fmt.Sprintf( |
| 188 | + "Skipping CLA check for repo='%s', actor: %s due to skip_cla config: '%s'", |
| 189 | + orgRepo, actorData, config, |
| 190 | + ) |
| 191 | + log.WithFields(f).Info(msg) |
| 192 | + eventData := events.BypassCLAEventData{ |
| 193 | + Repo: orgRepo, |
| 194 | + Config: config, |
| 195 | + Actor: actorData, |
| 196 | + } |
| 197 | + ev.LogEvent(&events.LogEventArgs{ |
| 198 | + EventType: events.BypassCLA, |
| 199 | + EventData: &eventData, |
| 200 | + UserID: id, |
| 201 | + UserName: login, |
| 202 | + ProjectID: projectID, |
| 203 | + }) |
| 204 | + log.WithFields(f).Debugf("event logged") |
| 205 | + actor.Authorized = true |
| 206 | + whitelistedActors = append(whitelistedActors, actor) |
| 207 | + } else { |
| 208 | + outActorsMissingCLA = append(outActorsMissingCLA, actor) |
| 209 | + } |
| 210 | + } |
| 211 | + |
| 212 | + return outActorsMissingCLA, whitelistedActors |
| 213 | +} |
0 commit comments