@elisra-devops/docgen-data-provider 0.4.6

package/src/modules/test/pipelineDataProvider.test.ts

@@ -0,0 +1,80 @@
+import DgDataProviderAzureDevOps from "../..";
+
+require("dotenv").config();
+jest.setTimeout(60000);
+
+const orgUrl = process.env.ORG_URL;
+const token = process.env.PAT;
+const dgDataProviderAzureDevOps = new DgDataProviderAzureDevOps(orgUrl,token);
+
+
+describe("pipeline module - tests", () => {
+  test("should return pipeline info", async () => {
+    let pipelinesDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider()
+    let json = await pipelinesDataProvider.getPipelineFromPipelineId(
+      "tests",
+      244
+    );
+    expect(json.id).toBe(244);
+  });
+  test("should return Release definition", async () => {
+    let pipelinesDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider()
+    let json = await pipelinesDataProvider.GetReleaseByReleaseId(
+      "tests",
+      1
+    );
+    expect(json.id).toBe(1);
+  });
+  test("should return OK(200) as response ", async () => {
+    let PipelineDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider();
+    let result = await PipelineDataProvider.TriggerBuildById(
+      "tests",
+      "14" ,
+      '{"test":"param1","age":"26","name":"denis" }'
+    );
+    expect(result.status).toBe(200);
+  });
+  test("should the path to zip file as response ", async () => {
+    let PipelineDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider();
+    let result = await PipelineDataProvider.GetArtifactByBuildId(
+      "tests",
+      "245", //buildId
+      "_tests" //artifactName
+    );
+    expect(result).toBeDefined();
+  });
+
+  test("should return pipeline run history ", async () => {
+    let PipelineDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider();
+    let json = await PipelineDataProvider.GetPipelineRunHistory(
+      "tests",
+      "14"
+    );
+    expect(json).toBeDefined();
+  })
+
+  test("should return release defenition history ", async () => {
+    let PipelineDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider();
+    let json = await PipelineDataProvider.GetReleaseHistory(
+      "tests",
+      "1"
+    );
+    expect(json).toBeDefined();
+  })
+
+  test("should return all pipelines ", async () => {
+    let PipelineDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider();
+    let json = await PipelineDataProvider.GetAllPipelines(
+      "tests"
+      );
+    expect(json).toBeDefined();
+  })
+
+  test("should return all releaseDefenitions ", async () => {
+    let PipelineDataProvider = await dgDataProviderAzureDevOps.getPipelinesDataProvider();
+    let json = await PipelineDataProvider.GetAllReleaseDefenitions(
+      "tests"
+      );
+    expect(json).toBeDefined();
+  })
+});

package/src/modules/test/testDataProvider.test.ts

@@ -0,0 +1,140 @@
+import DgDataProviderAzureDevOps from "../..";
+
+require("dotenv").config();
+jest.setTimeout(600000);
+
+const orgUrl = process.env.ORG_URL;
+const token = process.env.PAT;
+const dgDataProviderAzureDevOps = new DgDataProviderAzureDevOps(orgUrl,token);
+
+describe("Test module - tests", () => {
+  test("should return test plans", async () => {
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let json: any = await TestDataProvider.GetTestPlans("tests");
+    expect(json.count).toBeGreaterThanOrEqual(1);
+  });
+  test("should return test suites by plan", async () => { //not working yet
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let testSuites = await TestDataProvider.GetTestSuitesByPlan(
+      "tests",
+      "540",
+      true
+    );
+    expect(testSuites[0].name).toBe("TestSuite");
+  });
+  test("should return list of test cases", async () => {
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let attachList: any = await TestDataProvider.GetTestCasesBySuites(
+      "tests",
+      "545",
+      "546",
+      true
+    );
+    expect(attachList.length > 0).toBeDefined();
+  });
+  test("should use Helper.findSuitesRecursive twice after restarting static value of Helper.first=True ", async () => {
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let suitesByPlan = await TestDataProvider.GetTestSuitesByPlan(
+      "tests",
+      "545",
+      true
+    );
+    expect(suitesByPlan.length > 0).toBeDefined();
+  });
+  test.skip("should return list of test cases - stress test - big testplan 1400 cases", async () => {
+    jest.setTimeout(1000000);
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let attachList: any = await TestDataProvider.GetTestCasesBySuites(
+      "tests",
+      "540", 
+      "549", 
+      true
+    );
+    expect(attachList.length > 1000).toBeDefined(); //not enough test cases for stress test
+  });
+  test("should return test cases by suite", async () => {
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let json = await TestDataProvider.GetTestCases(
+      "tests",
+      "540",
+      "541"
+      );
+    expect(json.count).toBeGreaterThan(0);
+  });
+  test("should return test points by testcase", async () => {
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let json = await TestDataProvider.GetTestPoint(
+      "tests",
+      "540",
+      "541",
+      "542"
+      );
+    expect(json.count).toBeGreaterThan(0);
+  });
+  test("should return test runs by testcaseid", async () => {
+    let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+    let json = await TestDataProvider.GetTestRunById(
+      "tests",
+      "1000120"
+      );
+    expect(json.id).toBe(1000120);
+  });
+  test("should create run test according test pointId and return OK(200) as response ", async () => {
+      let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+        let result: any = await TestDataProvider.CreateTestRun(
+        "tests",
+        "testrun",
+        "540",
+        "3"
+      );
+      expect(result.status).toBe(200);
+    });
+  test("should Update runId state and return OK(200) as response ", async () => {
+      let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+      let result: any = await TestDataProvider.UpdateTestRun(
+        "tests",
+        "1000124", //runId
+        "NeedsInvestigation" //Unspecified ,NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation (State)
+      );
+      expect(result.status).toBe(200);
+    });  
+  test("should Update test case state and return OK(200) as response ", async () => {
+      let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+      let result: any = await TestDataProvider.UpdateTestCase(
+        "tests",
+        "1000120",
+        2 //0-reset , 1-complite , 2-passed , 3-failed (State)
+      );
+      expect(result.status).toBe(200);
+    });
+  test("should Upload attachment for test run and return OK(200) as response ", async () => {
+      let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+      let data = "This is test line of data";
+      let buff = new Buffer(data);
+      let base64data = buff.toString("base64");
+      let result: any = await TestDataProvider.UploadTestAttachment(
+        "1000120", //runID
+        "tests",
+        base64data, //stream
+        "testAttachment2.json", //fileName
+        "Test attachment upload", //comment
+        "GeneralAttachment" //attachmentType
+      );
+      expect(result.status).toBe(200);
+    });  
+  test("should Get all test case data", async () => {
+      let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+      let result: any = await TestDataProvider.GetTestSuiteByTestCase(
+        "544"
+      );
+      expect(result).toBeDefined;
+    });
+  test("should Get test points by test case id", async () => {
+      let TestDataProvider = await dgDataProviderAzureDevOps.getTestDataProvider();
+      let result: any = await TestDataProvider.GetTestPointByTestCaseId(
+        "tests",
+        "544" //testCaseId
+        );
+      expect(result).toBeDefined;
+    });
+  });

package/src/modules/test/ticketsDataProvider.test.ts

@@ -0,0 +1,138 @@
+import DgDataProviderAzureDevOps from "../..";
+
+require("dotenv").config();
+jest.setTimeout(60000);
+
+
+const orgUrl = process.env.ORG_URL;
+const token = process.env.PAT;
+const dgDataProviderAzureDevOps = new DgDataProviderAzureDevOps(orgUrl,token);
+
+const wiql =
+  "SELECT [System.Id],[System.WorkItemType],[System.Title],[System.AssignedTo],[System.State],[System.Tags] FROM workitems WHERE [System.TeamProject]=@project";
+
+describe("ticket module - tests", () => {
+  test("should create a new work item", async () => { 
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let body =
+      [{ 
+        op: "add",
+        path: "/fields/System.IterationPath",
+        value: "tests"
+      },
+      { 
+        op: "add",
+        path: "/fields/System.State",
+        value: "New"
+      },
+      { 
+        op: "add",
+        path: "/fields/System.AreaPath",
+        value: "tests"
+      },
+      { 
+        op: "add",  
+        path: "/fields/System.Title",
+        value: "new-test-title2"
+      },
+      {
+        op: "add",
+        path: "/fields/System.Tags",
+        value: "tag-test"
+      },
+      { 
+        op: "add",
+        path: "/fields/System.AssignedTo",
+        value: "denispankove"
+      }];
+    let res = await TicketDataProvider.CreateNewWorkItem(
+      "tests",
+      body,
+      "Epic",
+      true
+    );
+    expect(typeof res.id).toBe("number");
+    body[3].value = "edited";
+    let updatedWI = await TicketDataProvider.UpdateWorkItem(
+      "tests",
+      body,
+      res.id,
+      true
+    );
+    expect(updatedWI.fields["System.Title"]).toBe("edited");
+  });
+  test("should return shared queires", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let json = await TicketDataProvider.GetSharedQueries(
+      "tests",
+      "",
+    );
+    expect(json.length).toBeGreaterThan(1);
+  });
+  test("should return query results", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let json = await TicketDataProvider.GetSharedQueries(
+      "tests",
+      ""
+    );
+    let query = json.find((o: { wiql: undefined }) => o.wiql != undefined);
+    let result = await TicketDataProvider.GetQueryResultsByWiqlHref(
+      query.wiql.href,
+      "tests"
+    );
+    expect(result.length).toBeGreaterThanOrEqual(1);
+  });
+  test("should return query results by query id", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let result = await TicketDataProvider.GetQueryResultById(
+      "08e044be-b9bc-4962-99c9-ffebb47ff95a",
+      "tests"
+    );
+    expect(result.length).toBeGreaterThanOrEqual(1);
+  });
+  test("should return wi base on wiql string", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let result = await TicketDataProvider.GetQueryResultsByWiqlString(
+      wiql,
+      "tests"
+    );
+    expect(result.workItems.length).toBeGreaterThanOrEqual(1);
+  });
+  test("should return populated work items array", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let result = await TicketDataProvider.GetQueryResultsByWiqlString(
+      wiql,
+      "tests"
+    );
+    let wiarray = result.workItems.map((o: any) => o.id);
+    let res = await TicketDataProvider.PopulateWorkItemsByIds(
+      wiarray,
+      "tests"
+    );
+    expect(res.length).toBeGreaterThanOrEqual(1);
+  });
+  test("should return list of attachments", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let attachList = await TicketDataProvider.GetWorkitemAttachments(
+      "tests",
+      "538"
+    );
+    expect(attachList.length > 0).toBeDefined();
+  });
+  test("should return Json data of the attachment", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let attachedData = await TicketDataProvider.GetWorkitemAttachmentsJSONData(
+      "tests",
+      "14933c55-6d84-499c-88db-55202f16dd46"
+    );
+    expect(JSON.stringify(attachedData).length > 0).toBeDefined();
+  });
+  test("should return list of id & link object", async () => {
+    let TicketDataProvider = await dgDataProviderAzureDevOps.getTicketsDataProvider();
+    let attachList = await TicketDataProvider.GetLinksByIds(
+      "tests",
+      [535]
+    );
+    expect(attachList.length).toBeGreaterThan(0);
+  });
+}); //describe

package/src/utils/logger.ts

@@ -0,0 +1,37 @@
+"use strict";
+import * as winston from "winston";
+import BrowserConsole from "winston-transport-browserconsole";
+let logger: winston.Logger;
+
+const logFormat = winston.format.printf(
+  (info) => `${info.level} - ${info.message}`
+);
+
+// if (typeof window === "undefined") {
+//   let logsPath = process.env.logs_path || "./logs/";
+
+//   logger = winston.createLogger({
+//     format: winston.format.timestamp(),
+//     level: "silly",
+//     transports: [
+//       new winston.transports.File({
+//         filename: `${logsPath}azure-rest-api-errors.log`,
+//         level: "error",
+//         format: logFormat,
+//       }),
+//       new winston.transports.File({
+//         filename: `${logsPath}azure-rest-api-all.log`,
+//         format: logFormat,
+//       }),
+//       new winston.transports.Console({ format: logFormat, level: "debug" }),
+//     ],
+//   });
+// } else {
+logger = winston.createLogger({
+  format: winston.format.timestamp(),
+  level: "silly",
+  transports: [new BrowserConsole({ format: logFormat, level: "debug" })],
+});
+// }
+
+export default logger;

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ES2015",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "baseUrl": "./src",
+    "allowJs": true,
+    "checkJs": true,
+    "outDir": "./bin",
+    "declaration": true,
+    "sourceMap": true,
+    "strict": true,
+    "lib": ["ES2017", "DOM"],
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": false
+  },
+  "include": [
+    "**/*.ts"
+    // "test/test.ts",
+    // "test/sample.ts",
+    // "models/tfs-data.ts",
+    // "src/index.ts",
+    // "helpers/tfs.ts",
+    // "helpers/helper.ts"
+  ]
+}