Added policy sample (#225)

* Added policy sample

* Responding to feedback

* Added structure for creating/deleting project for running samples

* Integrated auto-created project in policy example

* Responding to feedback

* Fixed small issue with sample project deletion

Author: damccorm

samples/policy.ts

@@ -0,0 +1,63 @@
+import * as common from './common';
+import * as nodeApi from 'azure-devops-node-api';
+
+import * as PolicyApi from 'azure-devops-node-api/PolicyApi';
+import * as PolicyInterfaces from 'azure-devops-node-api/interfaces/PolicyInterfaces';
+import * as VSSInterfaces from 'azure-devops-node-api/interfaces/common/VSSInterfaces';
+
+export async function run(projectId: string) {
+    const webApi: nodeApi.WebApi = await common.getWebApi();
+    const policyApiObject: PolicyApi.IPolicyApi = await webApi.getPolicyApi();
+
+    common.banner('Policy Samples');
+
+    common.heading('Create Policy Configuration for this Project');
+    const newConfiguration: PolicyInterfaces.PolicyConfiguration = {isEnabled: true,
+                                                                    isBlocking: false,
+                                                                    type: {
+                                                                        id: "fa4e907d-c16b-4a4c-9dfa-4906e5d171dd",
+                                                                        displayName: undefined,
+                                                                        url: undefined
+                                                                      },
+                                                                    settings: {
+                                                                        minimumApproverCount: 1,
+                                                                        creatorVoteCounts: false,
+                                                                        scope: [{
+                                                                            repositoryId: null,
+                                                                            refName: "refs/heads/master",
+                                                                            matchKind: "exact"
+                                                                        }]},
+                                                                    _links: undefined,
+                                                                    createdBy: undefined,
+                                                                    createdDate: undefined,
+                                                                    isDeleted: undefined,
+                                                                    revision: undefined,
+                                                                    id: undefined,
+                                                                    url: undefined
+                                                                    };
+    await policyApiObject.createPolicyConfiguration(newConfiguration, projectId);
+
+    common.heading("Get Policy Configurations for this Project");
+    const configurations: PolicyInterfaces.PolicyConfiguration[] = await policyApiObject.getPolicyConfigurations(projectId);
+    const firstConfig: PolicyInterfaces.PolicyConfiguration = configurations[0];
+    const creatorIdentity: VSSInterfaces.IdentityRef = firstConfig.createdBy;
+    console.log("Configuration created by", creatorIdentity.displayName);
+
+    common.heading("Get revisions for this configuration");
+    const revisions: PolicyInterfaces.PolicyConfiguration[] = await policyApiObject.getPolicyConfigurationRevisions(projectId, firstConfig.id);
+    console.log("Revisions:", revisions);
+
+    common.heading("Get Policy Types for this Project");
+    const policies: PolicyInterfaces.PolicyType[] = await policyApiObject.getPolicyTypes(projectId);
+    console.log("Policy Types:", policies);
+
+    common.heading('Delete Policy Configuration');
+    await policyApiObject.deletePolicyConfiguration(projectId, firstConfig.id);
+    const deletedConfiguration: PolicyInterfaces.PolicyConfiguration = await policyApiObject.getPolicyConfiguration(projectId, firstConfig.id);
+    if (deletedConfiguration.isDeleted) {
+        console.log('Policy configuration successfully deleted');
+    }
+    else {
+        console.log('Unable to delete policy');
+    }
+}

samples/run.ts

@@ -4,8 +4,13 @@
 // export export API_TOKEN=<yourAllScopesApiToken>
 // export API_PROJECT=test
 import * as cm from './common';
+import * as nodeApi from 'azure-devops-node-api';
+import * as cApi from 'azure-devops-node-api/CoreApi';
+import * as coreInterfaces from 'azure-devops-node-api/interfaces/CoreInterfaces'
 
 let samples: string[] = require('./samples.json');
+let coreApi: cApi.ICoreApi;
+const maxLoops: number = 500;
 
 let selection: string = process.argv[2];
 if (selection) {
@@ -17,7 +22,77 @@ if (selection) {
     samples = [selection];
 }
 
+async function createProject(projectId: string): Promise<boolean> {
+    console.log('Cleaning up from last run');
+    if (!(await deleteProject(projectId))) {
+        console.log('Failed to delete previous project');
+        return false;
+    }
+
+    const projectToCreate: coreInterfaces.TeamProject = {name: projectId,
+                                                         description: 'sample project created automatically by azure-devops-node-api.',
+                                                         visibility: 1,
+                                                         capabilities: {versioncontrol: {sourceControlType: 'Git'}, 
+                                                                        processTemplate: {templateTypeId: '6b724908-ef14-45cf-84f8-768b5384da45'}},
+                                                         _links: null,
+                                                         defaultTeam: null,
+                                                         abbreviation: null,
+                                                         id: null,
+                                                         revision: null,
+                                                         state: null,
+                                                         url: null};
+    await coreApi.queueCreateProject(projectToCreate);
+
+    //Poll until project exists
+    let project: coreInterfaces.TeamProject = null;
+    console.log('Waiting for project to spin up');
+    let numLoops = 0;
+    while (numLoops < maxLoops) {
+        project = await coreApi.getProject(projectId);
+        numLoops += 1;
+        if (project) {
+            return true;
+        }
+    }
+    return false;
+}
+
+async function deleteProject(projectId: string): Promise<boolean> {
+    let project: coreInterfaces.TeamProject = await coreApi.getProject(projectId);
+    if (!project) {
+        //If no project to clean up, just return
+        console.log("Nothing to clean up");
+        return true;
+    }
+    await coreApi.queueDeleteProject(project.id);
+
+    //Poll until project no longer exists
+    console.log('Waiting for project to be deleted');
+    let numLoops = 0;
+    while (project && numLoops < maxLoops) {
+        project = await coreApi.getProject(projectId);
+        numLoops += 1;
+        if (!project) {
+            return true;
+        }
+    }
+    return false;
+}
+
 async function runSamples(selected?: string) {
+    const webApi: nodeApi.WebApi = await cm.getWebApi();
+    coreApi = await webApi.getCoreApi();
+    const projectId: string = 'azureDevopsNodeSampleProject';
+
+    cm.heading('Creating example project');
+    if (await createProject(projectId)) {
+        console.log('Project created');
+    }
+    else {
+        console.log('Failed to create project, exiting');
+        return;
+    }
+    
     for (let i: number = 0; i < samples.length; i++) {
         let sample: string = samples[i];
 
@@ -27,7 +102,15 @@ async function runSamples(selected?: string) {
 
         cm.banner('Sample ' + sample);
         var sm = require('./' + sample + '.js');
-        await sm.run();
+        await sm.run(projectId);
+    }
+
+    cm.heading('Cleaning up project');
+    if (await deleteProject(projectId)) {
+        console.log('Done');
+    }
+    else {
+        console.log('Failed to delete project');
     }
 }
 

samples/samples.json

@@ -2,6 +2,7 @@
     "build",
     "buildArtifact",
     "creation",
+    "policy",
     "task",
     "filecontainer",
     "git",

samples/tsconfig.json

@@ -9,6 +9,7 @@
         "build.ts",
         "buildArtifact.ts",
         "creation.ts",
+        "policy.ts",
         "task.ts",
         "filecontainer.ts",
         "git.ts",