@elisra-devops/docgen-data-provider 0.4.6

package/src/modules/GitDataProvider.ts

@@ -0,0 +1,446 @@
+import { TFSServices } from "../helpers/tfs";
+import TicketsDataProvider from "./TicketsDataProvider";
+import logger from "../utils/logger";
+export default class GitDataProvider {
+  orgUrl: string = "";
+  token: string = "";
+  ticketsDataProvider: TicketsDataProvider;
+
+  constructor(orgUrl: string, token: string) {
+    this.orgUrl = orgUrl;
+    this.token = token;
+    this.ticketsDataProvider = new TicketsDataProvider(
+      this.orgUrl,
+      this.token,
+    );
+  }
+  async GetTeamProjectGitReposList(
+    teamProject: string
+  ) {
+    logger.debug(`fetching repos list for team project - ${teamProject}`);
+    let url = `${this.orgUrl}/${teamProject}/_apis/git/repositories`;
+    return TFSServices.getItemContent(url, this.token, "get");
+  } //GetGitRepoFromPrId
+
+  async GetGitRepoFromRepoId(
+    repoId: string
+  ) {
+    logger.debug(`fetching repo data by id - ${repoId}`);
+    let url = `${this.orgUrl}_apis/git/repositories/${repoId}`;
+    return TFSServices.getItemContent(url, this.token, "get");
+  } //GetGitRepoFromPrId
+
+  async GetJsonFileFromGitRepo(
+    projectName: string,
+    repoName: string,
+    filePath: string
+  ) {
+    let url = `${this.orgUrl}${projectName}/_apis/git/repositories/${repoName}/items?path=${filePath}&includeContent=true`;
+    let res = await TFSServices.getItemContent(url, this.token, "get");
+    let jsonObject = JSON.parse(res.content);
+    return jsonObject;
+  } //GetJsonFileFromGitRepo
+
+  async GetGitRepoFromPrId(
+    pullRequestId: number
+  ) {
+    let url = `${this.orgUrl}_apis/git/pullrequests/${pullRequestId}`;
+    let res = await TFSServices.getItemContent(url, this.token, "get");
+    return res;
+  } //GetGitRepoFromPrId
+
+  async GetPullRequestCommits(
+    repositoryId: string,
+    pullRequestId: number
+  ) {
+    let url = `${this.orgUrl}_apis/git/repositories/${repositoryId}/pullRequests/${pullRequestId}/commits`;
+    let res = await TFSServices.getItemContent(url, this.token, "get");
+    return res;
+  } //GetGitRepoFromPrId
+
+  async GetPullRequestsLinkedItemsInCommitRange(
+    projectId: string,
+    repositoryId: string,
+    commitRangeArray: any
+  ) {
+    let pullRequestsFilteredArray: any = [];
+    let ChangeSetsArray: any = [];
+    //get all pr's in git repo
+    let url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/pullrequests?status=completed&includeLinks=true&$top=2000}`;
+    logger.debug(`request url: ${url}`);
+    let pullRequestsArray = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get"
+    );
+    logger.info(
+      `got ${pullRequestsArray.count} pullrequests for repo: ${repositoryId}`
+    );
+    //iterate commit list to filter relavant pullrequests
+    pullRequestsArray.value.forEach((pr: any) => {
+      commitRangeArray.value.forEach((commit: any) => {
+        if (pr.lastMergeCommit.commitId == commit.commitId) {
+          pullRequestsFilteredArray.push(pr);
+        }
+      });
+    });
+    logger.info(
+      `filtered in commit range ${pullRequestsFilteredArray.length} pullrequests for repo: ${repositoryId}`
+    );
+    //extract linked items and append them to result
+    await Promise.all(
+      pullRequestsFilteredArray.map(async (pr: any) => {
+        let linkedItems: any = {};
+        try {
+          if (pr._links.workItems.href) {
+            //get workitems linked to pr
+            let url: string = pr._links.workItems.href;
+            linkedItems = await TFSServices.getItemContent(
+              url,
+              this.token,
+              "get"
+            );
+            logger.info(
+              `got ${linkedItems.count} items linked to pr ${pr.pullRequestId}`
+            );
+            await Promise.all(
+              linkedItems.value.map(async (item: any) => {
+                let populatedItem = await this.ticketsDataProvider.GetWorkItem(
+                  projectId,
+                  item.id
+                );
+                let changeSet: any = {
+                  workItem: populatedItem,
+                  pullrequest: pr,
+                };
+                ChangeSetsArray.push(changeSet);
+              })
+            );
+          }
+        } catch (error) {
+          logger.error(error);
+        }
+      })
+    );
+    return ChangeSetsArray;
+  } //GetPullRequestsInCommitRange
+
+  async GetItemsInCommitRange( 
+    projectId: string,
+    repositoryId: string,
+    commitRange:any
+  ) {
+    //get all items linked to commits
+    let res: any = [];
+    let commitChangesArray: any = [];
+    //extract linked items and append them to result
+    for (const commit of commitRange.value) {
+      if (commit.workItems) {
+        for (const wi of commit.workItems) {
+          let populatedItem = await this.ticketsDataProvider.GetWorkItem(
+            projectId,
+            wi.id
+          );
+          let changeSet: any = { workItem: populatedItem, commit: commit };
+          commitChangesArray.push(changeSet);
+        }
+      }
+    }
+    //get all items and pr data from pr's in commit range - using the above function
+    let pullRequestsChangesArray =
+      await this.GetPullRequestsLinkedItemsInCommitRange(
+        projectId,
+        repositoryId,
+        commitRange
+      );
+    //merge commit links with pr links
+    logger.info(`got ${pullRequestsChangesArray.length} items from pr's and`);
+    res = [...commitChangesArray, ...pullRequestsChangesArray];
+    let workItemIds :any = []
+    for (let index = 0; index < res.length; index++) {
+      if (workItemIds.includes(res[index].workItem.id)){
+        res.splice(index, 1); 
+        index--;
+      }
+      else{
+        workItemIds.push(res[index].workItem.id)
+      }
+    }
+    return res;
+  } //GetItemsInCommitRange
+
+  async GetPullRequestsInCommitRangeWithoutLinkedItems(
+    projectId: string,
+    repositoryId: string,
+    commitRangeArray: any
+  ) {
+    let pullRequestsFilteredArray: any[] = [];
+  
+    // Extract the organization name from orgUrl
+    let orgName = this.orgUrl.split('/').filter(Boolean).pop();
+  
+    // Get all PRs in the git repo
+    let url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/pullrequests?status=completed&includeLinks=true&$top=2000}`;
+    logger.debug(`request url: ${url}`);
+    let pullRequestsArray = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get"
+    );
+    logger.info(
+      `got ${pullRequestsArray.count} pullrequests for repo: ${repositoryId}`
+    );
+  
+    // Iterate commit list to filter relevant pull requests
+    pullRequestsArray.value.forEach((pr: any) => {
+      commitRangeArray.value.forEach((commit: any) => {
+        if (pr.lastMergeCommit.commitId == commit.commitId) {
+          // Construct the pull request URL
+          const prUrl = `https://dev.azure.com/${orgName}/${projectId}/_git/${repositoryId}/pullrequest/${pr.pullRequestId}`;
+  
+          // Extract only the desired properties from the PR
+          const prFilteredData = {
+            pullRequestId: pr.pullRequestId,
+            createdBy: pr.createdBy.displayName,
+            creationDate: pr.creationDate,
+            closedDate: pr.closedDate,
+            title: pr.title,
+            description: pr.description,
+            url: prUrl  // Use the constructed URL here
+          };
+          pullRequestsFilteredArray.push(prFilteredData);
+        }
+      });
+    });
+    logger.info(
+      `filtered in commit range ${pullRequestsFilteredArray.length} pullrequests for repo: ${repositoryId}`
+    );
+  
+    return pullRequestsFilteredArray;
+  } // GetPullRequestsInCommitRangeWithoutLinkedItems
+  
+
+  async GetCommitByCommitId(
+    projectId: string,
+    repositoryId: string,
+    commitSha: string
+  ) {
+    let url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/commits/${commitSha}`;
+    return TFSServices.getItemContent(url, this.token, "get");
+  }
+
+  async GetCommitForPipeline(
+    projectId: string,
+    buildId: number
+  ) {
+    let url = `${this.orgUrl}${projectId}/_apis/build/builds/${buildId}`;
+    let res = await TFSServices.getItemContent(url, this.token, "get");
+    return res.sourceVersion;
+  } //GetCommitForPipeline
+
+  async GetItemsForPipelinesRange(
+    projectId: string,
+    fromBuildId: number,
+    toBuildId: number
+  ) {
+    let linkedItemsArray: any = [];
+    let url = `${this.orgUrl}${projectId}/_apis/build/workitems?fromBuildId=${fromBuildId}&toBuildId=${toBuildId}&$top=2000`;
+    let res = await TFSServices.getItemContent(url, this.token, "get");
+    logger.info(
+      `recieved ${res.count} items in build range ${fromBuildId}-${toBuildId}`
+    );
+    await Promise.all(
+      res.value.map(async (wi: any) => {
+        let populatedItem = await this.ticketsDataProvider.GetWorkItem(
+          projectId,
+          wi.id
+        );
+        let changeSet: any = { workItem: populatedItem, build: toBuildId };
+        linkedItemsArray.push(changeSet);
+      })
+    );
+    return linkedItemsArray;
+  } //GetCommitForPipeline
+
+
+  async GetCommitsInDateRange(
+    projectId: string,
+    repositoryId: string,
+    fromDate: string,
+    toDate: string,
+    branchName?: string
+  ) {
+    let url:string 
+    if (typeof branchName !== 'undefined') {
+      url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/commits?searchCriteria.fromDate=${fromDate}&searchCriteria.toDate=${toDate}&searchCriteria.includeWorkItems=true&searchCriteria.$top=2000&searchCriteria.itemVersion.version=${branchName}`;
+    }
+    else{
+      url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/commits?searchCriteria.fromDate=${fromDate}&searchCriteria.toDate=${toDate}&searchCriteria.includeWorkItems=true&searchCriteria.$top=2000`;
+    }
+    return TFSServices.getItemContent(url, this.token, "get");
+  } //GetCommitsInDateRange
+
+  async GetCommitsInCommitRange(
+    projectId: string,
+    repositoryId: string,
+    fromSha: string,
+    toSha: string
+  ) {
+    let url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/commits?searchCriteria.fromCommitId=${fromSha}&searchCriteria.toCommitId=${toSha}&searchCriteria.includeWorkItems=true&searchCriteria.$top=2000`;
+    return TFSServices.getItemContent(url, this.token, "get");
+  } //GetCommitsInCommitRange doesen't work!!!
+  
+  async CreatePullRequestComment(
+    projectName: string,
+    repoID: string,
+    pullRequestID: number,
+    threads: any
+  ) {
+    let url: string = `${this.orgUrl}${projectName}/_apis/git/repositories/${repoID}/pullRequests/${pullRequestID}/threads?api-version=5.0`;
+    let res: any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "post",
+      threads,
+      null
+    );
+    return res;
+  }
+
+  async GetPullRequestComments(
+    projectName: string,
+    repoID: string,
+    pullRequestID: number
+  ) {
+    let url: string = `${this.orgUrl}${projectName}/_apis/git/repositories/${repoID}/pullRequests/${pullRequestID}/threads`;
+    return TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+  }
+
+  async GetCommitsForRepo(
+    projectName: string,
+    repoID: string,
+    branchName?: string
+  ){ 
+    let url: string
+    if (typeof branchName !== 'undefined') {
+      url = `${this.orgUrl}${projectName}/_apis/git/repositories/${repoID}/commits?searchCriteria.$top=2000&searchCriteria.itemVersion.version=${branchName}`
+    }
+    else{
+       url = `${this.orgUrl}${projectName}/_apis/git/repositories/${repoID}/commits?searchCriteria.$top=2000`
+    }
+      let res:any = await TFSServices.getItemContent(
+        url,
+        this.token,
+        "get",
+        null,
+        null
+        );
+        return res;
+  }
+
+  async GetPullRequestsForRepo(
+    projectName: string,
+    repoID: string
+  ){
+    let url: string = 
+    `${this.orgUrl}${projectName}/_apis/git/repositories/${repoID}/pullrequests?status=completed&includeLinks=true&$top=2000}`;
+
+    let res:any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+    return res;
+  }
+
+  
+  async GetItemsInPullRequestRange(
+    projectId: string,
+    repositoryId: string,
+    pullRequestIDs: any,
+  ) {
+    let pullRequestsFilteredArray: any = [];
+    let ChangeSetsArray: any = [];
+    //get all pr's in git repo
+    let url = `${this.orgUrl}${projectId}/_apis/git/repositories/${repositoryId}/pullrequests?status=completed&includeLinks=true&$top=2000}`;
+    logger.debug(`request url: ${url}`);
+    let pullRequestsArray = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get"
+    );
+    logger.info(
+      `got ${pullRequestsArray.count} pullrequests for repo: ${repositoryId}`
+    );
+    //iterate commit list to filter relavant pullrequests
+    pullRequestsArray.value.forEach((pr: any) => {
+      pullRequestIDs.forEach((prId: any) => {
+        if (prId == pr.pullRequestId) {
+          pullRequestsFilteredArray.push(pr);
+        }
+      });
+    });
+    logger.info(
+      `filtered in prId range ${pullRequestsFilteredArray.length} pullrequests for repo: ${repositoryId}`
+      );
+    //extract linked items and append them to result
+    await Promise.all(
+      pullRequestsFilteredArray.map(async (pr: any) => {
+        let linkedItems: any = {};
+        try {
+          if (pr._links.workItems.href) {
+            //get workitems linked to pr
+            let url: string = pr._links.workItems.href;
+            linkedItems = await TFSServices.getItemContent(
+              url,
+              this.token,
+              "get"
+            );
+            logger.info(
+              `got ${linkedItems.count} items linked to pr ${pr.pullRequestId}`
+            );
+            await Promise.all(
+              linkedItems.value.map(async (item: any) => {
+                let populatedItem = await this.ticketsDataProvider.GetWorkItem(
+                  projectId,
+                  item.id
+                );
+                let changeSet: any = {
+                  workItem: populatedItem,
+                  pullrequest: pr,
+                };
+                ChangeSetsArray.push(changeSet);
+              })
+            );
+          }
+        } catch (error) {
+          logger.error(error);
+        }
+      })
+    );
+    return ChangeSetsArray;
+  }
+
+  async GetRepoBranches(
+    projectName: string,
+    repoID: string
+    ){
+      let url: string = `${this.orgUrl}${projectName}/_apis/git/repositories/${repoID}/refs?searchCriteria.$top=1000&filter=heads`
+        let res:any = await TFSServices.getItemContent(
+          url,
+          this.token,
+          "get",
+          null,
+          null
+          );
+          return res;
+  }
+}

package/src/modules/MangementDataProvider.ts

@@ -0,0 +1,59 @@
+import { TFSServices } from "../helpers/tfs";
+import logger from "../utils/logger";
+
+export default class MangementDataProvider {
+  orgUrl: string = "";
+  token: string = "";
+  
+  constructor(orgUrl: string, token: string) {
+    this.orgUrl = orgUrl;
+    this.token = token;
+  }
+
+  async GetCllectionLinkTypes() {
+    let url: string = `${this.orgUrl}_apis/wit/workitemrelationtypes`;
+    let res: any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+    return res;
+  }
+
+  //get all projects 
+  async GetProjects(): Promise<any> {
+    let projectUrl: string = `${this.orgUrl}_apis/projects?$top=1000`;
+    let projects: any = await TFSServices.getItemContent(
+      projectUrl,
+      this.token
+    );
+    return projects;
+  }
+
+  // get project by  name return project object
+  async GetProjectByName(
+    projectName: string
+  ): Promise<any> {
+    try {
+      let projects: any = await this.GetProjects();
+      for (let i = 0; i < projects.value.length; i++) {
+        if (projects.value[i].name === projectName) return projects.value[i];
+      }
+      return {};
+    } catch (err) {
+      console.log(err);
+      return {};
+    }
+  }
+
+  // get project by id return project object
+  async GetProjectByID(
+    projectID: string
+  ): Promise<any> {
+    let projectUrl: string = `${this.orgUrl}_apis/projects/${projectID}`;
+    let project: any = await TFSServices.getItemContent(projectUrl, this.token);
+    return project;
+  }
+}

package/src/modules/PipelinesDataProvider.ts

@@ -0,0 +1,142 @@
+import { TFSServices } from "../helpers/tfs";
+
+import logger from "../utils/logger";
+
+export default class PipelinesDataProvider {
+  orgUrl: string = "";
+  token: string = "";
+
+  constructor(orgUrl: string, token: string) {
+    this.orgUrl = orgUrl;
+    this.token = token;
+  }
+
+  async getPipelineFromPipelineId(projectName: string, buildId: number) {
+    let url = `${this.orgUrl}${projectName}/_apis/build/builds/${buildId}`;
+    return TFSServices.getItemContent(url, this.token, "get");
+  } //GetCommitForPipeline
+
+  async TriggerBuildById(
+    projectName: string,
+    buildDefanitionId: string,
+    parameter: any
+  ) {
+    let data = {
+      definition: {
+        id: buildDefanitionId,
+      },
+      parameters: parameter, //'{"Test":"123"}'
+    };
+    logger.info(JSON.stringify(data));
+    let url = `${this.orgUrl}${projectName}/_apis/build/builds?api-version=5.0`;
+    let res = await TFSServices.postRequest(
+      url,
+      this.token,
+      "post",
+      data,
+      null
+    );
+    return res;
+  }
+
+  async GetArtifactByBuildId(
+    projectName: string,
+    buildId: string,
+    artifactName: string
+  ): Promise<any> {
+    try {
+      logger.info(
+        `Get artifactory from project ${projectName},BuildId ${buildId} artifact name ${artifactName}`
+      );
+      logger.info(`Check if build ${buildId} have artifact`);
+      let url = `${this.orgUrl}${projectName}/_apis/build/builds/${buildId}/artifacts`;
+      let response = await TFSServices.getItemContent(
+        url,
+        this.token,
+        "Get",
+        null,
+        null
+      );
+      if (response.count == 0) {
+        logger.info(`No artifact for build ${buildId} was published `);
+        return response;
+      }
+      url = `${this.orgUrl}${projectName}/_apis/build/builds/${buildId}/artifacts?artifactName=${artifactName}`;
+      let res = await TFSServices.getItemContent(
+        url,
+        this.token,
+        "Get",
+        null,
+        null
+      );
+      logger.info(`Url for download :${res.resource.downloadUrl}`);
+      let result = await TFSServices.downloadZipFile(
+        res.resource.downloadUrl,
+        this.token
+      );
+      return result;
+    } catch (err) {
+      logger.error(`Error : ${err}`);
+      throw new Error(String(err));
+    }
+  }
+
+  async GetReleaseByReleaseId(
+    projectName: string,
+    releaseId: number
+  ): Promise<any> {
+    let url = `${this.orgUrl}${projectName}/_apis/release/releases/${releaseId}`;
+    url = url.replace("dev.azure.com", "vsrm.dev.azure.com");
+    return TFSServices.getItemContent(url, this.token, "get", null, null);
+  }
+
+  async GetPipelineRunHistory(projectName: string, pipelineId: string) {
+    let url: string = `${this.orgUrl}${projectName}/_apis/pipelines/${pipelineId}/runs`;
+    let res: any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+    return res;
+  }
+
+  async GetReleaseHistory(projectName: string, definitionId: string) {
+    let url: string = `${this.orgUrl}${projectName}/_apis/release/releases?definitionId=${definitionId}&$top=2000`;
+    url = url.replace("dev.azure.com", "vsrm.dev.azure.com");
+    let res: any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+    return res;
+  }
+
+  async GetAllPipelines(projectName: string) {
+    let url: string = `${this.orgUrl}${projectName}/_apis/pipelines?$top=2000`;
+    let res: any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+    return res;
+  }
+
+  async GetAllReleaseDefenitions(projectName: string) {
+    let url: string = `${this.orgUrl}${projectName}/_apis/release/definitions?$top=2000`;
+    url = url.replace("dev.azure.com", "vsrm.dev.azure.com");
+    let res: any = await TFSServices.getItemContent(
+      url,
+      this.token,
+      "get",
+      null,
+      null
+    );
+    return res;
+  }
+}