How to override summary of your release or build ?

Posted on Updated on


If you want to add additional panel into your summary of your release instance,
I suggest you to add new markdown, upload this last with vso specific task.
Aggregate this development into custom task link.

Below detail of your development :

1. Begin by adding your mark down template file, set this later into task directory.
1

2. Add your markdown data file , into the same directory.

3. below content of your two files.

Template is (Template file ensure that we load for every release the same template with same keys) :

# Section name #
- Artefact 1 : @@Artefact1@@
- Artefact 2 : @@Artefact2@@

Data is (Data file is published on server for every release):

# Section name #
 - Artefact 1 : @@Artefact1@@
- Artefact 2 : @@Artefact2@@

Remark : Theses two files have same content.

4. Now we add Wrapper.ps1 file permit you to execute backend treatment, below content of your file.
For our case, we decide to get datas of testing layer.

[CmdletBinding()]
param(
  # VARIABLES TAKEN FROM THE VSTS EXTENSION
  [string] $artefact1,
  [string] $artefact2
)

Function permit you to access vsts or tfs platform, without enter credentials.

function Get-AccessToken
{
	Write-Verbose -Verbose "Getting Personal Access Token for the Run" 
	$vssEndPoint = Get-ServiceEndPoint -Name "SystemVssConnection" -Context $distributedTaskContext
	$personalAccessToken = $vssEndpoint.Authorization.Parameters.AccessToken
	if (!$personalAccessToken) 
	{ 
		throw "Could not extract personal access token. Exitting"     
	} 
	$personalAccessToken
}

Load template file markdown, access datas and set datas into data file.

$template = (Get-Content $PSScriptRoot\readmeTemplate.md)

#replace artefact
$template.Replace("@@Artefact1@@", $artefact1) | Set-Content $PSScriptRoot\readme.md

#get access
$token = Get-AccessToken
$returnObj = @{}
$url = "$($env:SYSTEM_TEAMFOUNDATIONSERVERURI)$($env:SYSTEM_TEAMPROJECT)/_apis/test/runs?api-version=1.0"
$response = Invoke-RestMethod -Method Get -Uri $url -Headers @{Authorization = "Bearer $token"}

if($response -eq $null)
{
	Write-Host "We don't have datas..."
}
else
{
	.....
        (Get-Content $PSScriptRoot\readme.md).replace("@@Artefact2@@", $artefact2) | Set-Content $PSScriptRoot\readme.md 

}

Upload specific section into summary, with vso tasks.

Write-Host "##vso[task.uploadsummary]$PSScriptRoot\readme.md"

Documentation link vso tasks

Below screen describing result

2

Advertisements

Access to VSTS Releases by C# in preview version

Posted on Updated on


vstsde

This post describes somes lines of code which permit you to access VSTS platform (Visual Studio Team Service), we describe fundamntal steps permit to access new objects and services, we begin by decsribing packages that you have to download from NUGET in order to develop access layers.

The benefits of this post is to identify easily list of packages and class that you have known, in order access datas, without forget that we are in preview version.

Firslty begin by adding theses packages, we remarks that we add Microsoft.VisualStudio.Services.Release.Client package with preview version.

Below full list of packages that you have download :

-Microsoft.AspNet.WebApi.Client with version =5.2.2
-Microsoft.AspNet.WebApi.Core with version =5.2.2
-Microsoft.IdentityModel.Clients.ActiveDirectory with version =3.13.5
-Microsoft.TeamFoundation.DistributedTask.Common.Contracts with version =15.120.0-preview
-Microsoft.TeamFoundationServer.Client with version =15.120.0-preview
-Microsoft.TeamFoundationServer.ExtendedClient with version =15.120.0-preview
-Microsoft.Tpl.Dataflow with version =4.5.24
-Microsoft.VisualStudio.Services.Client with version =15.120.0-preview
-Microsoft.VisualStudio.Services.InteractiveClient with version =15.120.0-preview
-Microsoft.VisualStudio.Services.Release.Client with version =15.120.0-preview
-Newtonsoft.Json with version =8.0.3
-System.IdentityModel.Tokens.Jwt with version =4.0.2.206221351
-WindowsAzure.ServiceBus with version =3.3.2

Below source code permit you to create release definition, we define VssClientCredentials object permit to ensure connection to your VSTS, so you need to register your login and your token.

If you wish to get token, go to security panel of your VSTS, and create basic token with retency of 90 days.

token

We create VssClientCredentials with credentials, for etablish connection with VSTS we define VssConnection object based on credentials.

ReleaseHttpClient is the service permit you to access releases. based on ReleaseHttpClientBase abstract class.

ReleaseHttpClientBase permit you to create, delete, update, modify your definitions.

In this sample we create definition of release.

 VssClientCredentials credentialsDestination = new VssClientCredentials
                            (new VssBasicCredential(ConfigurationManager.AppSettings["loginForMigration"],
                                                            ConfigurationManager.AppSettings["tokenForMigration"]));

            using (VssConnection connectionDestination = new VssConnection(serverUrlDestination, credentialsDestination))
            {
                using (var releaseHttpClient = connectionDestination.GetClient())
                {
                    try
                    {
                        
                        Task releaseDefinitionTask = releaseHttpClient.CreateReleaseDefinitionAsync(releaseDefinition, projectName);
                        releaseDefinitionTask.Wait();
                        
                    }
                    catch (Exception ex)
                    {
                        throw ex;
                    }
                }
            }

After describing call of CreateReleaseDefinitionAsync, we speak about business rules that definition have to respect.

Constraints on VSTS :

  • Definition must have Id.
  • Definition must have Name unique.
  • On each environment of your release you have to define RetentionPolicy with three properties DaysToKeep, RetainBuild and ReleasesToKeep.
  • We three types of agents, in order to stay coherent with TFS platform, we use AgentDeploymentInput type as agent.

Remarks : In the future evolutions we preconise to use Deployment group, so replace AgentBasedDeployPhase type with MachineGroupBasedDeployPhase type.

 foreach (var environment in definition.Environments)
 {
                environment.RetentionPolicy = new EnvironmentRetentionPolicy
                {
                    DaysToKeep = daysToKeep,
                    RetainBuild = true,
                    ReleasesToKeep = releasesToKeep
                };

                var agentDeploymentInput = new AgentDeploymentInput
                {
                };

                if (agentName == AgentNameDefaultConstant)
                {
                    agentDeploymentInput.QueueId = 1;
                }

                DeployPhase deployPhase = new AgentBasedDeployPhase
                {
                    Name = deployPhaseName,
                    Rank = deployPhaseRank,
                    DeploymentInput = agentDeploymentInput
                };

                environment.DeployPhases.Add(deployPhase);

                // Adjust tasks of step
                if (environment.DeployStep != null &&
                    environment.DeployStep.Tasks.Any())
                {
                    deployPhase.WorkflowTasks = .....;
                }
}

All tasks are contained on DeployPhase object.

GC.Collect

Subscriber Policy TFS check-in

Posted on Updated on


In order to filter about your check-in operations, for example for branching organised arround Featuring, constraint is to ensure that we don’t check-in on main branch, because it’s later have to stay clean, you haven’t check’in source on Main branch, all changes have to contain merge action , after quality test process on features.

So this post will speak about create custom check-in policy, we have two solutions :

  • First is to create subscriber, deployed on server, centralized for all TFS instances
  • Second is to create VSIX, deployed if needed by an customer

We develop into this post custom subscriber, permitting to filter on changes, ensuring that we have unless merge action.

Remark : Constraint is due to news TFS APIs 2017.

Below list of steps that you have to follow in order to accomplish this goal

1.Create library class

2. Add reference to following assemblies :

  • Microsoft.TeamFoundation.Common
  • Microsoft.TeamFoundation.Framework.Server
  • Microsoft.TeamFoundation.Server.Core
  • Microsoft.TeamFoundation.VersionControl.Server

3.Create class named MergeNotificationSubscriber implementing ISubscriber interface

Below specific implementing of members :

public string Name
{
get
{
throw new NotImplementedException();
}
}

public SubscriberPriority Priority
{
get
{
throw new NotImplementedException();
}
}
public EventNotificationStatus ProcessEvent(IVssRequestContext requestContext, NotificationType notificationType, object notificationEventArgs, out int statusCode, out string statusMessage, out ExceptionPropertyCollection properties)
{
throw new NotImplementedException();
}

public Type[] SubscribedTypes()
{
throw new NotImplementedException();
}

For Name property, you can define your message of your strategy

public string Name
{
get
{
return "Require Merge operations on Integration and Production branch";
}
}

For your priority, you can set to high

public SubscriberPriority Priority
{
get
{
return SubscriberPriority.High;
}
}

For type of operations, we specify check-in notifications

/// Subscribeds the types.
///
/// permit to define subscribed tyeps public Type[] SubscribedTypes()
{
return new Type[1] { typeof(CheckinNotification) };
}

Our logic will be placed into ProcessEvent method, note that we have condition on DecisionPoint, signify that we catch request before check-in action (Similar to http module, we pass every time into code on server forfor each request).

 

/// Processes the event.
///The request context. 
///Type of the notification. 
///The notification event arguments. 
///The status code. 
///The status message. 
///The properties. 
/// permit to define status public EventNotificationStatus ProcessEvent(IVssRequestContext requestContext, NotificationType notificationType, object notificationEventArgs, out int statusCode, out string statusMessage, out ExceptionPropertyCollection properties) 

{ 

const string IntegrationPatternTeamProject = "$/..."; 
const string ProductionPatternTeamProject = "$/..."; 
const string TemplateMessageWindowConstant = "Check-in was rejected due to a type action on item, have to be equal to merge"; 
const string CollectionNameConstant = "..."; 
statusCode = 0; 
properties = new ExceptionPropertyCollection(); 
statusMessage = String.Empty; 

//Ensure that policy is applied just on target collection 
if(requestContext.ServiceHost.Name != CollectionNameConstant) 
{ 
return EventNotificationStatus.ActionPermitted; 
} 

if (notificationType == NotificationType.DecisionPoint) 
{ 
if (notificationEventArgs is CheckinNotification) 
{ 
CheckinNotification checkinNotification = notificationEventArgs as CheckinNotification; 
var teamFoundationVersionControlService = requestContext.GetService(); 
var submittedItems = checkinNotification.GetSubmittedItems(requestContext); 

if (!submittedItems.All(x => x.Contains(IntegrationPatternTeamProject) || x.Contains(ProductionPatternTeamProject))) 
{ 
return EventNotificationStatus.ActionPermitted; 
} 

using (var teamFoundationDataReader = teamFoundationVersionControlService.QueryPendingChangesForWorkspace(requestContext, checkinNotification.WorkspaceName, checkinNotification.WorkspaceOwner.UniqueName, checkinNotification.GetSubmittedItems(requestContext).Select(i => new ItemSpec(i, RecursionType.None)).ToArray(), false, 100, null, true)) 
{ 
if (teamFoundationDataReader != null) 
{ 
var nonMergedItem = teamFoundationDataReader.CurrentEnumerable().FirstOrDefault(c => c.MergeSources == null || c.MergeSources.Count == 0); 

if (nonMergedItem != null) 
{ 
TeamFoundationApplicationCore.Log(TemplateMessageWindowConstant, 2010, EventLogEntryType.Information); 
statusMessage = TemplateMessageWindowConstant; 
return EventNotificationStatus.ActionDenied; 
} 
}
} 
} 
} 

return EventNotificationStatus.ActionApproved; 
}

GC.Collect

Get Release Management Datas With API REST TFS

Posted on Updated on


Microsoft has released a documentation of the VSTS and TFS integrating REST APIs. In the recent past we were using the client object model and API to interact with TFS. But it was very difficult for client which don’t have .Net Framework installed, and after installation of this later, you must to have Visual Studio, install dependencies on TFS assemblies, know C# …..
Now you can interact with VSTS and TFS via POWERSHELL scripts, or another language, with simple instructions.
It implies also an openness to other technologies and also ease of use.
You specify different HTTP verbs (such as GET, PUT, POST and PATCH) and the connection point to a specific URI (Uniform Resource Identifier) to interact with the API.
In our post we will define the URI of our TFS server, our project collection and also that of the team project.

$UriCollectionProject =  $TFSInstanceURL+"/"+$ProjectCollection+"/_apis/projects?api-version=2.2-preview.1"
$CollectionResponse = Invoke-RestMethod -Method Get -Credential $credential -ContentType application/json -Uri $UriCollectionProject  

When pointing to TFS, you can pass a username and password (masked as a secret variable) through
So we must to add theses lines below

$User = "Aghilas.yakoub"
$Password = "MyPassword" 
$securePassword = $Password | ConvertTo-SecureString -AsPlainText -Force  
$credential = New-Object System.Management.Automation.PSCredential($User, $securePassword)  

Us in this post we will try to list Releases runned by a specific person.
So secondly we will try to retrieve the list of team projects in a collection.
Emeber that a collection contains a set of project and a project contains a set of releases.
Below calling a GET on the URL of the collection.

$UriCollection =  $TFSURL+"/"+$ProjectCollectionName+"/_apis/projects?api-version=2.2-preview.1"
$CollectionResponse = Invoke-RestMethod -Method Get -Credential $credential -ContentType application/json -Uri $UriCollection

$CollectionResponse contains set of team projects.

foreach ($project in $CollectionResponse.value)
{
    $TeamProject= $project.Name 
	….
}

Now in a second time we will try to retrieve the list of release on a team project.
We will use the following suffix: /_apis/release/releases?api-version=2.2-preview.1

Ref : https://www.visualstudio.com/en-us/docs/integrate/api/rm/releases#get-a-release

#Construct URI for query team prpject and his releases
$Uri = $TFSURL +"/"+$ ProjectCollectionName +"/"+$TeamProject+"/_apis/release/releases?api-version=2.2-preview.1"

#Get response of previous uri
$releaseresponse = Invoke-RestMethod -Method Get -Credential $credential -ContentType application/json -Uri $Uri 

Now we must just get created releases by Aghilas


    foreach ($releaseInstance in $releaseresponse.value)
    { 
	If($releaseInstance.createdBy –eq “Aghilas”)
	{
             ......
        } 
    }

GC.Collect

Document your extension TFS before publish – Markdown

Posted on Updated on


This post is here in order to help you to improve quality on published extension on market place, because we have lot of extensions without documentation, so it’s very hard to use theses, we can add documentation easily by defining markdown.
We have set of steps to follow in order to document.

1. Create your markdown file , add readme.md to your library, if you have one extension library with set of task, suggest you to have one mardown for all tasks.

Remarks: Your file don’t need to be copied in content, let default options.

readme

Below samples of common syntax of markdown :

# This is an H1
## This is an H2
###### This is an H6
*Italic characters*
_Italic characters_
**bold characters**
__bold characters__
~~strikethrough text~~
This is [an example](http://www.amayestech.com/) inline link.

You can also install markdown extension in order to modify easily :

extensionmd

After installing Markdown Editor, can view the design of my code, view small symbol M on my file.

extensionmdEditor

complete doc here : https://code.visualstudio.com/docs/languages/markdown

2. Register your readme.md file into manifeste extension by adding section of code below

register

3. For this sample we add images in readme.md, theses images must be copied to directory img (content / do not copy)
and registered into manifeste extension

registerimg

Now after packaging and publishing actions, if we go to market place manager, we can view documentation of your extension.

 

Package and publish your extension TFS 2015 VNEXT

Posted on Updated on


In order apeak about solution , we explain just that we have two aspects to setup, packaging and publishing, we begin with our sample with packaging.

  • PACKAGING View

For the packaging we follow steps below in order to construct our package, the result of this step is vsix file.

1. Setup Node.js

2. Install vset tool with this command : npm install vset –save-dev

vnext12

3. Run Node.js command prompt tool (C:\Windows\System32\cmd.exe /k “C:\Program Files (x86)\nodejs\nodevars.bat”)

4. Locate you on directory of your extension

5. Run vset package command

vnext13

Your vsix is generated into your root irectory

vnext13

For information you can inspect content of your extension, by unzip your vsix

vnext15

  • PUBLISHING View

Before publish our extension it’s possible to visit differents extension avaiable on the cloud, it’s possible to download and install on premise version of tfs, in order to reuse.

We choose to publish our expansion on the market place on Azure

We follow theses steps, firstly we create a publisher, secondly

1. Go to https://marketplace.visualstudio.com/manage/publishers/
2. Choose to create a publisher by completing a unique Id

vnext10
After that
vnext9
3. Upload your extension by drag and drop your vsix
vnext11

4. Correct and adapt your manifest information

vnext16

5. Now it’s ok and my vsix is downloaded

vnext17

6. Share my extension on my account azure, an it’s possible to update my version on clickin on update button
vnext18

vnext19

7. Go to admin tfs section, and selection extension tab, clck on my extension target

vnext19

vnext20

8. On Build VNEXT find my created extension

vnext21

Create your extension TFS 2015 VNEXT

Posted on Updated on


Start by downloading a template project, you have two project templates, one dedicated to the integration part, another dedicated to the realization of custom build or release tasks.

In this post we will realize an extension that will aim to start an application pool, without managing this specify.

For the part back we will combine our extension with a shell script.

Begin with open Explorer Visual Studio extensions,

Install the following template :

vnext1

Below is a detail on the different of your solution.

Most of these directories will be deleted in the second time.

vnext2

Now we will start developing our own extension,

First, delete the files that we use nothing:

  1. Remove the test directory
  2. Remove typings directory
  3. Delete the file app.ts
  1. Add directory Sample
  2. Create a powershell file Sample.ps1
  3. Create a task manifest file task.json
  4. Create logo into directory

Below the output of created project

vnext3

  1. Edit the task.json by defining your layout based on controls and groups concepts, inputs are your controls typed with type propecty, and are grouped into groups, by using group property (Below sample of grouping, we have three groups)

vnext5

Below the task.json file after modify

vnext4

We have another section related to call code behind, for our project, code behind is powersell, it can be another type

  1. Implement your Code behind and match with your layout arguments

Ensure that arguments ps1 match with json arguments, in execution section on your json, ensure that you have referenced your target file.

 

vnext6.png

  1. For debugging after implementing, open your ps ise, you can find-it in C:\Windows\System32\WindowsPowerShell\v1.0\powershell_ise.exe

Ensure that you have right of debugging by executing this script, and just click F5

vnext7

  1. Register your extension in the manifeste

vnext8.png

GC.Collect