Plugin Version: 1.0.1
Last Update on: December 20, 2019
Overview
Team Foundation Server (commonly abbreviated to TFS) is a Microsoft product that provides source code management (either with Team Foundation Version Control or Git), reporting, requirements management, project management (for both agile software development and waterfall teams), automated builds, lab management, testing and release management capabilities. It covers the entire application lifecycle, and enables DevOps capabilities. TFS can be used as a back-end to numerous integrated development environments (IDEs) but is tailored for Microsoft Visual Studio and Eclipse on all platforms.
This plugin was developed and tested against version present on TFS 2019
Plugin Operation:
CheckOutCode
Input parameter(s):
Parameter
Is Mandatory
Help Text
tf.exe Directory path
true
Installed TFS Path, Note: If this is invalid the file download will be stucked
Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Mapped Workspace Directory
true
Mapped path with TFS. If no workspace is mapped with the given path the files won’t download
Ex : C:/Demo
All
false
You can use this option to restore an item that you have accidentally deleted from a server workspace. (This is the command-line ‘/all’ option
Overwrite
false
By default, the system does not retrieve an item if it is writable
that is, if its read-only attribute is cleared) on the client machine.
This option overrides the default behavior and overwrites a writable item,
unless the item is checked out. (This is the command-line ‘/overwrite’ option)
Force
false
Combines /all and /overwrite. (This is the command-line ‘/force’ option)
Recursive
false
Recursively gets items in the specified directory and any subdirectories. (This is the command-line ‘/recursive’ option)
Output parameter(s):
Parameter
Help Text
FilePath
Filepath where the files are been downloaded.
IsFilesPresent
Is download Successfull.
TFSStatus
Final CheckOutCode job status.
Pass/Fail Condition:
Status
Condition
Passed
All Path should be valid.
Downloaded file should be physically present in the path provided in configuration
Failed
Outputlog should contain ‘Unable to determine the workspace’.
IsMappingExist
Input parameter(s):
Parameter
Is Mandatory
Help Text
tf.exe Directory path
true
Installed TFS Path, Note: If this is invalid the file download will be stucked
Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Mapped Workspace Directory
true
Mapped path with TFS. If no workspace is mapped with the given path the files won’t download
Workspace Name
true
Check the Workpspace whether path is mapped or notworkspace. (This is the command-line ‘/all’ option
Output parameter(s):
Parameter
Help Text
FilePath
Filepath where the files are been downloaded.
WorkspaceName
Name of the workspace
TFSStatus
Final IsMappingExist job status.
Pass/Fail Condition:
Status
Condition
Passed
Outputlog should contain ‘Mapped Workspace Directory’.
Failed
Outputlog should contain ‘does not exist’ or
‘Mapped Workspace Directory’ not found.
CreateAndMapWorkspace
Input parameter(s):
Parameter
Is Mandatory
Help Text
tf.exe Directory path
true
Installed TFS Path, Note: If this is invalid the file download will be stucked
Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Mapped Workspace Directory
true
Mapped path with TFS. If no workspace is mapped with the given path the files won’t download
Root Directory
true
Check the Workpspace whether path is mapped or not. (This is the command-line ‘/all’ option
TFS URL
true
The URL of Team Foundation Server i.e.http://<domain>:<port>/tfs
Source Control Folder
true
The path that will be mapped with local folder
Workspace Name
true
Name of the Workspace
Output parameter(s):
Parameter
Help Text
FilePath
Filepath where the files are been downloaded.
WorkspaceName
Name of the workspace
TFSStatus
Final CreateAndMapWorkspace job status.
Pass/Fail Condition:
Status
Condition
Passed
If the outputlog is empty.
Failed
Outputlog should contain ‘is already mapped in workspace’ or or ‘already exists on computer’
DeleteWorkspace
Input parameter(s):
Parameter
Is Mandatory
Help Text
tf.exe Directory path
true
Installed TFS Path, Note: If this is invalid the file download will be stucked
Ex: C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\TeamFoundation\Team Explorer\tf.exe
Workspace Name
true
Name of the Workspace
Output parameter(s):
Parameter
Help Text
WorkspaceName
Is Delete Successfull.
TFSStatus
Final DeleteWorkspace job status.
Pass/Fail Condition:
Status
Condition
Passed
If the outputlog is empty.
Failed
Outputlog should contain ‘does not exist.’
Disclaimers:
Conflicts cannot be handle using this plugin.
Release Details:
TFS: 1.0.1
Initial version with basic functionalities
