@elisra-devops/docgen-data-provider 0.4.6

package/.github/sonar-project.properties

@@ -0,0 +1,5 @@
+sonar.sources=src
+sonar.language=typescript
+# sonar.javascript.lcov.reportPaths=coverage\SonarQube.xml
+# sonar.typescript.lcov.reportPaths=coverage\SonarQube.xml
+sonar.coverageReportPaths=coverage/SonarQube.xml

package/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: "🚀 ci"
+
+on: [pull_request]
+
+jobs:
+  build_and_test:
+    name: 🚀 build  and test
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📚 checkout
+        uses: actions/checkout@v2
+      - name: 🟢 node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+      - run: npm install
+      - run: npm run build
+        env:
+          ORG_URL: ${{secrets.AZDO_ORG_URL}}
+          PAT: ${{secrets.AZDO_PAT}}

package/.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: "🚀 publish"
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  release:
+    name: 🚀 publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📚 checkout
+        uses: actions/checkout@v2
+
+      - name: 🟢 node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+
+      - run: npm install
+
+      - run: npm run build
+
+      - name: 'Automated Version Bump'
+        uses: 'phips28/gh-action-bump-version@master'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          commit-message: 'CI: bumps version to {{version}} [skip ci]'
+
+      - name: 🚀 publish
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Assaf Yacobi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# dg-data-provider-azuredevops
+
+[![npm version](https://badge.fury.io/js/@doc-gen%2Fdg-data-provider-azuredevops.svg)](https://badge.fury.io/js/@doc-gen%2Fdg-data-provider-azuredevops)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[![Chat on Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/channels/904432165901709333/904432165901709336)
+
+An azuredevops data provider using the document generator interface.
+supported modules:
+
+- **managment** - a module for retriving general purpose data, for example: number of projects and projects detailes.
+- **git** - a module for retriving git related data, for example: commit detailes, branches etc.
+- **pipelines** - a module for retriving pipelines data, for example: pipline history, pipline details etc.
+- **tests** - a module for retriving tests data, for example:testplans list, test steps etc.
+- **tickets** - a module for retriving tickets data, for example: open tickets, tickets list by query results etc.
+
+### Installation:
+
+```
+npm i @doc-gen/dg-data-provider-azuredevops
+```
+
+### Usage:
+
+```
+import DgDataProviderAzureDevOps from "@doc-gen/dg-data-provider-azuredevops";
+
+let dgDataProviderAzureDevOps = new DgDataProviderAzureDevOps(
+      orgUrl,
+      token
+    );
+    let gitDataProvider = await dgDataProviderAzureDevOps.getGitDataProvider();
+
+
+```
+
+### Contributors:

package/enviroment.d.ts

@@ -0,0 +1,12 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      ORG_URL: string;
+      PAT: string;
+    }
+  }
+}
+ 
+// If this file has no import/export statements (i.e. is a script)
+// convert it into a module by adding an empty export statement.
+export {};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@elisra-devops/docgen-data-provider",
+  "version": "0.4.6",
+  "description": "A document generator data provider, aimed to retrive data from azure devops",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/assafushy/dg-data-provider-azuredevops.git"
+  },
+  "private": false,
+  "main": "./bin/index.js",
+  "types": "./bin/index.d.ts",
+  "scripts": {
+    "test": "jest --coverage --runInBand --forceExit",
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.2.1",
+    "@types/request": "^2.48.5",
+    "dotenv": "^10.0.0",
+    "jest": "^26.0.1",
+    "jest-junit": "^10.0.0",
+    "npm": "^6.14.5",
+    "ts-jest": "^25.5.1",
+    "typescript": "^3.6.3"
+  },
+  "dependencies": {
+    "@types/xml2js": "^0.4.5",
+    "axios": "^0.19.2",
+    "request": "^2.88.2",
+    "winston": "^3.2.1",
+    "winston-transport-browserconsole": "^1.0.5",
+    "xml2js": "^0.4.23"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testPathIgnorePatterns": [
+      "/bin/"
+    ],
+    "reporters": [
+      "default",
+      "jest-junit"
+    ]
+  },
+  "jest-junit": {
+    "output": "./junit.xml"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/assafushy/dg-data-provider-azuredevops/issues"
+  },
+  "homepage": "https://github.com/assafushy/dg-data-provider-azuredevops#readme"
+}

package/src/helpers/helper.ts

@@ -0,0 +1,117 @@
+import { Query, Workitem } from "../models/tfs-data";
+
+export class suiteData {
+  name: string;
+  id: string;
+  parent: string;
+  level: number;
+  url: string;
+  constructor(name: string, id: string, parent: string, level: number) {
+    this.name = name;
+    this.id = id;
+    this.parent = parent;
+    this.level = level;
+  }
+}
+export class Relations {
+  id: string;
+  rels: Array<string> = new Array<string>();
+}
+
+export class Links {
+  id: string;
+  title: string;
+  description: string;
+  url: string;
+  type: string;
+  customerId: string;
+}
+export class Trace {
+  id: string;
+  title: string;
+  url: string;
+  customerId: string;
+  links: Array<Links>;
+}
+
+export class Helper {
+  static level: number = 1;
+  static first: boolean = true;
+  static buildSuiteslevel(dataSuites: any): any {}
+  public static suitList: Array<suiteData> = new Array<suiteData>();
+  public static findSuitesRecursive(
+    planId: string,
+    url: string,
+    project: string,
+    suits: any,
+    foundId: string,
+    recursive: boolean
+  ): Array<suiteData> {
+    for (let i = 0; i < suits.length; i++) {
+      if (suits[i].parentSuiteId != 0) {
+        if (suits[i].parentSuiteId == foundId) {
+          let suit: suiteData = new suiteData(
+            suits[i].title,
+            suits[i].id,
+            foundId,
+            this.level++
+          );
+          suit.url =
+            url +
+            project +
+            "/_testManagement?planId=" +
+            planId +
+            "&suiteId=" +
+            suits[i].id +
+            "&_a=tests";
+          this.suitList.push(suit);
+          if (recursive == false) {
+            return this.suitList;
+          }
+          this.findSuitesRecursive(
+            planId,
+            url,
+            project,
+            suits,
+            suits[i].id,
+            true
+            );
+          this.level--;
+        }
+      } else {
+          if (suits[i].id == foundId && Helper.first) {
+            let suit: suiteData = new suiteData(
+              suits[i].title,
+              suits[i].id,
+              foundId,
+              this.level
+            );
+            suit.url = url + project + "/_workitems/edit/" + suits[i].id;
+            Helper.first = false;
+            if (recursive == false) {
+              return this.suitList;
+            }
+          }
+        }
+    }
+    return this.suitList;
+  }
+  public static levelList: Array<Workitem> = new Array<Workitem>();
+  public static LevelBuilder(results: Query, foundId: string): Array<Workitem> {
+    for (let i = 0; i < results.workItems.length; i++) {
+      if (results.workItems[i].Source == 0) {
+        results.workItems[i].level = 0;
+        if (!this.levelList.includes(results.workItems[i]))
+          this.levelList.push(results.workItems[i]);
+      } else if (results.workItems[i].Source.toString() == foundId) {
+        results.workItems[i].level = this.level++;
+        this.levelList.push(results.workItems[i]);
+
+        this.LevelBuilder(results, results.workItems[i].fields[0].value);
+        this.level--;
+      }
+    }
+
+    return this.levelList;
+  }
+}

package/src/helpers/tfs.ts

@@ -0,0 +1,92 @@
+import axios from "axios";
+import logger from "../utils/logger";
+import * as request from "request";
+
+export class TFSServices {
+  public static async downloadZipFile(url: string, pat: string): Promise<any> {
+    let json;
+    try {
+      var d = {
+        request: {
+          method: "getUser",
+          auth: {
+            username: "",
+            password: `${pat}`,
+          },
+        },
+      };
+      let res = await request({
+        url: url,
+        headers: { "Content-Type": "application/zip" },
+        auth: {
+          username: "",
+          password: pat,
+        },
+        encoding: null,
+      });
+      return res;
+    } catch (e) {
+      logger.error(`error download zip file , url : ${url}`);
+      throw new Error(String(e));
+    }
+  }
+
+  public static async getItemContent(
+    url: string,
+    pat: string,
+    requestMethod: string = "get",
+    data: any = {},
+    customHeaders: any = {}
+  ): Promise<any> {
+    let config: any = {
+      headers: customHeaders,
+      method: requestMethod,
+      auth: {
+        username: "",
+        password: pat,
+      },
+      data: data,
+    };
+    let json;
+    logger.silly(`making request:
+    url: ${url}
+    config: ${JSON.stringify(config)}`);
+    try {
+      let result = await axios(url, config);
+      json = JSON.parse(JSON.stringify(result.data));
+    } catch (e) {
+      logger.error(`error making request to azure devops , url : ${url}`);
+      // logger.error(JSON.stringify(e.data));
+    }
+    return json;
+  }
+
+  public static async postRequest(
+    url: string,
+    pat: string,
+    requestMethod: string = "post",
+    data: any,
+    customHeaders: any = {}
+  ): Promise<any> {
+    let config: any = {
+      headers: customHeaders,
+      method: requestMethod,
+      auth: {
+        username: "",
+        password: pat,
+      },
+      data: data,
+    };
+    let result;
+    logger.silly(`making request:
+    url: ${url}
+    config: ${JSON.stringify(config)}`);
+    try {
+      result = await axios(url, config);
+    } catch (e) {
+      logger.error(`error making post request to azure devops`);
+      console.log(e);
+    }
+    return result;
+  }
+}

package/src/index.ts

@@ -0,0 +1,36 @@
+import MangementDataProvider from './modules/MangementDataProvider'
+import TicketsDataProvider from './modules/TicketsDataProvider'
+import GitDataProvider from "./modules/GitDataProvider";
+import PipelinesDataProvider from './modules/PipelinesDataProvider'
+import TestDataProvider from './modules/TestDataProvider'
+
+import logger from "./utils/logger";
+
+export default class DgDataProviderAzureDevOps {
+  orgUrl: string = "";
+  token: string = "";
+  apiVersion: string;
+  
+  
+  constructor(orgUrl: string, token: string, apiVersion?: string) {
+    this.orgUrl = orgUrl;
+    this.token = token;
+    logger.info(`azure devops data provider initilized`);
+  }
+
+  async getMangementDataProvider() : Promise<MangementDataProvider> {
+    return new MangementDataProvider(this.orgUrl, this.token);
+  }
+  async getTicketsDataProvider() : Promise<TicketsDataProvider> {
+    return new TicketsDataProvider(this.orgUrl, this.token);
+  }
+  async getGitDataProvider() : Promise<GitDataProvider> {
+    return new GitDataProvider(this.orgUrl, this.token);
+  }
+  async getPipelinesDataProvider() : Promise<PipelinesDataProvider> {
+    return new PipelinesDataProvider(this.orgUrl, this.token);
+  }
+  async getTestDataProvider() : Promise<TestDataProvider> {
+    return new TestDataProvider(this.orgUrl, this.token);
+  }
+} //class

package/src/models/tfs-data.ts

@@ -0,0 +1,137 @@
+
+export class QueryAllTypes {
+  q: Query;
+  source: number;
+}
+
+export class Query {
+  queryType: QueryType;
+  queryResultType: QueryResultType;
+  asOf: Date;
+  columns: Column[] = new Array<Column>();
+  //sortColumns: Sortcolumn[]  =new Array<Sortcolumn>()
+  workItems: Workitem[] = new Array<Workitem>();
+}
+class QueryTree {
+  queryType: QueryType;
+  queryResultType: QueryResultType;
+  asOf: Date;
+  columns: Column[] = new Array<Column>();
+  //sortColumns: Sortcolumn[]  =new Array<Sortcolumn>()
+  workItems: Workitemrelation[] = new Array<Workitemrelation>();
+}
+
+export class Column {
+  referenceName: string;
+  name: string;
+  url: string;
+}
+
+class Sortcolumn {
+  field: Field;
+  descending: boolean;
+}
+
+class Field {
+  referenceName: string;
+  name: string;
+  url: string;
+}
+
+export class Workitem {
+  id: number;
+  url: string;
+  parentId: number;
+  fields: value[];
+  Source: number = 0;
+  attachments: any[];
+  level:number;
+}
+export class value {
+  name: string;
+  value: string;
+}
+enum QueryResultType {
+  WorkItem = 1,
+  WorkItemLink = 2
+}
+export enum QueryType {
+  Flat = "flat",
+  Tree = "tree",
+  OneHop = "oneHop"
+}
+
+class Workitemrelation {
+  rel: string;
+  source: Source;
+  target: Target;
+}
+
+class Workrelation {
+  relation: Workitemrelation;
+  value: value;
+}
+
+class Source {
+  id: number;
+  url: string;
+}
+
+class Target {
+  id: number;
+  url: string;
+}
+
+export interface Comment {
+  parentCommentId: number;
+  content: string;
+  commentType: number;
+}
+
+export interface RightFileEnd {
+  line: number;
+  offset: number;
+}
+
+export interface RightFileStart {
+  line: number;
+  offset: number;
+}
+
+export interface ThreadContext {
+  filePath: string;
+  leftFileEnd?: any;
+  leftFileStart?: any;
+  rightFileEnd: RightFileEnd;
+  rightFileStart: RightFileStart;
+}
+
+export interface IterationContext {
+  firstComparingIteration: number;
+  secondComparingIteration: number;
+}
+
+export interface PullRequestThreadContext {
+  changeTrackingId: number;
+  iterationContext: IterationContext;
+}
+
+export interface RootObject {
+  comments: Comment[];
+  status: number;
+  threadContext: ThreadContext;
+  pullRequestThreadContext: PullRequestThreadContext;
+}
+export class TestCase {
+  id:String;
+  title:String;
+  description:String;
+  area: String;
+  steps: TestSteps[];
+  suit: string;
+  url:string;
+}
+export class TestSteps {
+  action: String;
+  expected: String;
+}