make check for exclude teams case insensitive by storing as lower case and comparing to lower case (#29)

* new setting added EXCLUDE_TEAMS to AppConfig, added note in README

* add check for ExcludeTeams and ignore processing of team if in the array

* make check for exclude teams case insensitive by storing as lower case and comparing to lower case

Author: scottluskcis

README.md

@@ -105,6 +105,9 @@ GITHUB_API_VERSION=2022-11-28
 # valid values are day, week, month, quarter, or year 
 TIME_PERIOD=month
 
+# any teams to exclude from the results (comma separated list)
+EXCLUDE_TEAMS=team1,team2
+
 # pretty, json, hidden
 LOG_TYPE=pretty
 

src/data/copilot-associations-data.ts

@@ -2,6 +2,7 @@ import { listCopilotSeats } from "../restapi/copilot";
 import { getAuditLogForActor } from "../restapi/organizations";
 import { listRepoContributors } from "../restapi/repositories";
 import { listTeamMembers, listTeams } from "../restapi/teams";
+import { AppConfig } from "../shared/app-config";
 import logger from "../shared/app-logger";
 import { CopilotSeatAssignee, Repository, TeamInfo, TimePeriodType } from "../shared/shared-types";
 import { timestampToDate } from "../shared/time-util";
@@ -123,6 +124,10 @@ async function processRepositories(repository_owner_name: string, seat_assignee:
 async function fetchOrgTeamsMembers(org: string, per_page: number, teams: { [team: string]: TeamInfo }, org_copilot_seats: CopilotSeatAssignee[]) { 
   let team_count: number = 0; 
   for await (const team of listTeams({ org, per_page })) { 
+    if (AppConfig.EXCLUDE_TEAMS.includes(team.slug.toLowerCase())) {
+      continue;
+    }
+
     processTeams(org, team.slug, per_page, teams, org_copilot_seats); 
     team_count++;
   }

src/report/copilot-associations-report.ts

@@ -109,6 +109,10 @@ function getTeamAssociations(data: CopilotAssociationsData): { member: string, t
   const member_teams: { [member: string]: Set<string> } = {};
 
   for (const team_name in data.teams) {
+    if(AppConfig.EXCLUDE_TEAMS.includes(team_name.toLowerCase())) {
+      continue;
+    }
+
     const team = data.teams[team_name];
     const copilot_users = new Set(team.copilot_users);
 

src/shared/app-config.ts

@@ -12,6 +12,10 @@ export class AppConfig {
   public static readonly GENERATE_DATA: boolean = AppConfig.getEnvVar("GENERATE_DATA", "true").toLowerCase() === "true";
   public static readonly GITHUB_TOKENS_BY_ORG: { [key: string]: string } = AppConfig.getTokensByOrg(AppConfig.getEnvVar("GITHUB_TOKENS_BY_ORG"));
   public static readonly PER_PAGE: number = parseInt(AppConfig.getEnvVar("PER_PAGE", "100"));
+  public static readonly EXCLUDE_TEAMS: string[] = AppConfig.getEnvVar("EXCLUDE_TEAMS", "")
+    .split(",")
+    .map((team) => team.trim().toLowerCase())
+    .filter((team) => team !== "");
 
   // logging settings
   public static readonly MIN_LOG_LEVEL: number = parseInt(AppConfig.getEnvVar("MIN_LOG_LEVEL", "3"));