jasminsehic / infinity.net

.NET API for Azure DevOps and DevOps Server formerly Visual Studio Online and Team Foundation Server

Infinity.NET

Infinity.NET is a .NET client library for the Azure DevOps REST API, providing access to Azure DevOps servers.

Example

var client = new TfsClient(new TfsClientConfiguration
{
    Url = new Uri("https://dev.azure.com/YourOrganization"),
    Credentials = new NetworkCredential("username", "password"),
});

var projects = client.Project.GetProjects().Result;

Progress

Infinity.NET is a work in progress; it is not yet fully complete. Here are the currently implemented client functions:

• Git: 100%
• Projects and Teams
  • Projects: 100%
  • Teams: 100%
• Team Rooms
  • Messages: 100%
  • Rooms: 100%
  • Users: 100%

Unit Tests

The REST APIs are tested by mocking them, using the Azure DevOps REST API Reference examples. To add a new test:

1. Add the expected JSON output from the REST method in the Infinity.Tests/Resources directory. Ensure that the file is added to the Infinity.Tests project.

2. Add the file as a resource to the Infinity.Tests project.

3. Add a new unit test that expects the appropriate URL and (for POST or PUT methods) the appropriate JSON input and returns the given resource. For example:

    TfsClient mockClient = NewMockClient(
        new MockRequestConfiguration
        {
            // The URI given in the API Reference
            Uri = "/_apis/model/action",
   
            // The name of the resource containing the JSON response
            ResponseResource = "Model.Action",
        });
   
    Model model = base.ExecuteSync<Model>(
        () => { return client.Model.Action(); });
   

4. Write the test assertions. You can use the Infinity.Tests/Resources/test_from_json.pl script to generate assertions from the expected JSON output.

Command-Line Interface

A simple command-line interface is available in the Infinity.Clients project. For example, to merge a pull request:

Infinity.Client https://dev.azure.com/YourOrganization
--username=username --password=password Git.UpdatePullRequest
<RepositoryId> <PullRequestId> Completed <CommitId

This project is not made to be authoritative, but it may help in development and debugging.

License

Copyright (c) Edward Thomson. All rights reserved.

Available under the MIT license (refer to the LICENSE file).

infinity.net's Issues

Any plans for WorkItems?

This library looks really high quality, but the last commit was in January. Do you have plans to implement Work Item querying? Without that, it's of rather limited usefulness. Would you accept Pull Requests for it?

Regards,
Pi Lanningham

GetItem returns file contents instead of metadata due to missing header

As per the API docs (see here) to get metadata for an item you need to add the Accept: application/json header.

GetItem() on the GitClient doesn't do this, so the file contents are returned instead. This causes an exception when attempting to deserialize the JSON into an object of type Item.

GetItems() fails on submodule items.

Basically because the "commit" item type is not mapped in the ObjectType enum.
Pull request incoming.

[blueprint] pull requests policies management API

Hi Edward,

It would be great if this library could support the management of pull request policies. They have been introduced in TFS 2015, and they help the administrators to define review policies, default reviewers by file path, and so on (I bet you already know this ;-) -- other guys: have a look at this video https://channel9.msdn.com/Events/Visual-Studio/Visual-Studio-2015-Final-Release-Event/Git-Branches-and-Policies-in-Team-Foundation-Server-2015).

I could propose a pull request, if only there was a public and documented API.... :-)

Error: {"Unauthorized"}

So, I copied the example verbatim and am targeting a brand new account. I am 100% certain the credentials are correct. Is there something I am missing?

var client = new TfsClient(new TfsClientConfiguration
      {
        Url = new Uri(collectionUri),
        Credentials = new NetworkCredential(username,password),
      });

      IEnumerable<Project> projects = new List<Project>();
      Task.Run(async () =>
      {
        projects = await client.Project.GetProjects(); // <-- throws {"Unauthorized"}
      }).Wait();

Infinity should support an OAuth access token for VSO

Authentication should be supported via OAuth as well as the current basic authentication for VSO.

The dev should be able to pass the token into the TfsClientConfiguration .

Need support for session tokens (aka personal access tokens)

Visual Studio Online now has support for scoped access tokens. If Infinity.NET supported them, then there would be no need for any complex authentication protocol support. It would involve a dependency on the Azure Directory Authentication Libraries (ADAL).

If that's allowed, I can help by adding in the required things to support session tokens.