README.md

QWIQ

QWIQ is a Quick Work Item Query library for Team Foundation Server / Visual Studio Online. If you do a lot of reading or writing of work items, this package is for you!

What can it be used for?

Querying Team Foundation Server, of course! Instead of directly using the TFS Client OM, you could use QWIQ! It it made of packages designed to make working with Tfs/Vso a pleasure. Qwiq.Core is the no-frills base package, exposinng the raw types needed to read and write work items. Qwiq.Identity adds methods to simplify converting between your preferred method of identity (display names, user names) and TFS's identity classes. Qwiq.Linq provides a Linq query provider to be able to write Linq to query tfs. Qwiq.Mapper enables converting from IWorkItem, the raw Qwiq.Core type, to your own classes to enable strongly typed access to your WorkItems. Qwiq.Relatives extends Qwiq.Linq to enable slightly more complicated queries allowing for basic queries of related workitems. Qwiq.Mocks provides default implementations for commonly mocked classes within Qwiq, and should allow for getting up and unit testing quickly. Why use this over the Client OM? Glad you asked!

1. Easier to consume

Let's be honest, the TFS libraries are a pain to use. There are a lot of them, several are dynamically loaded, and a few are native. While we can't avoid it, you can! Just install the Qwiq.Core package and everything will be in your \bin folder when you need it.

2. Easier to test

Qwiq makes testing your apps a breeze. Everything has an interface. Everything uses factories (or factory methods) instead of constructors. Just mock what you need for your tests and go. No more messy, temperamental fakes, or adapters cluttering your code.

3. Easier to understand

How often do you update a work item? How often do you create a new security group? We stripped out the rarely used stuff to make interfaces cleaner and the relationships between types simpler. Missing something you can't live without? Send us a pull request!

How to install it

Add our MyGet feed to your NuGet clients:

• v3 (VS 2015+ / NuGet 3.x): https://www.myget.org/F/qwiq/api/v3/index.json
• v2 (VS 2013 / NuGet 2.x): https://www.myget.org/F/qwiq/api/v2

Once the feed is configured, instald via the nuget UI (as Microsoft.Qwiq.Core), or via the nuget package manager console:

Install Core

PM> Install-Package Microsoft.Qwiq.Core

Basic Usage

using Microsoft.Qwiq;
using Microsoft.Qwiq.Credentials;
...

// Create credentials objects based on the current process and OS identity
// We support
//  - Username and password
//  - PAT
//  - Federated Windows credentials
var creds = CredentialsFactory.CreateCredentials();
var uri = new Uri("[Tfs Tenant Uri]");

var store = WorkItemStoreFactory
                .GetInstance()
                .Create(uri, creds);
//               ^^^ store and re-use this!

// Execute WIQL
var items = store.Query(@"
    SELECT [System.Id] 
    FROM WorkItems 
    WHERE WorkItemType = 'Bug' AND State = 'Active'");

[Reflection.Assembly]::LoadFrom("E:\Path\To\Microsoft.Qwiq.Core.dll")

$creds = [Microsoft.Qwiq.Credentials.CredentialsFactory]::CreateCredentials()
$uri = [Uri]"[Tfs Tenant Uri]"
$store = [Microsoft.Qwiq.WorkItemStoreFactory]::GetInstance().Create($uri, $creds)

$items = $store.Query(@"
    SELECT [System.Id] 
    FROM WorkItems 
    WHERE WorkItemType = 'Bug' AND State = 'Active'")

Contributing

Getting started with Git and GitHub

• Setting up Git for Windows and connecting to GitHub
• Forking a GitHub repository
• The simple guide to GIT guide
• Open an issue if you encounter a bug or have a suggestion for improvements/features

Once you're familiar with Git and GitHub, clone the repository and start contributing!