Downloads:

327,341

Downloads of v 4.0.0:

26,887

Last Update:

6/12/2019

Package Maintainer(s):

Software Author(s):

  • JetBrains

Tags:

teamcity build agent ci continuous integration admin

TeamCity Build Agent

4.0.0 | Updated: 6/12/2019

Downloads:

327,341

Downloads of v 4.0.0:

26,887

Software Author(s):

  • JetBrains

TeamCity Build Agent 4.0.0

This Package Contains an Exempted Check

1 Test Passing and 1 Exempted Test


Validation Testing Passed


Verification Testing Exempt:

Requires Team City Server

To install TeamCity Build Agent, run the following command from the command line or from PowerShell:

>

To upgrade TeamCity Build Agent, run the following command from the command line or from PowerShell:

>

To uninstall TeamCity Build Agent, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade teamcityagent -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade teamcityagent -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure teamcityagent installed
  win_chocolatey:
    name: teamcityagent
    state: present
    version: 4.0.0
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'teamcityagent' do
  action    :install
  version  '4.0.0'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: teamcityagent,
    Version: 4.0.0,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller teamcityagent
{
   Name     = 'teamcityagent'
   Ensure   = 'Present'
   Version  = '4.0.0'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'teamcityagent':
  provider => 'chocolatey',
  ensure   => '4.0.0',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install teamcityagent version="4.0.0" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved as a trusted package on 6/12/2019.

Description

TeamCity Build Agent for jetbrains.com/teamcity. It is a piece of software which listens for the commands from the TeamCity server and starts the actual build processes. Install requires at least serverUrl parameter, e.g. -params 'serverurl=http://...', also supported are agentName, agentDir, ownPort and possibly others. If looking to see what changes in the agent config files during the run use -v argument to choco.exe.


tools\chocolateybeforemodify.ps1

$ErrorActionPreference = 'Stop' # stop on all errors

$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
# Don't use ConvertFrom-StringData as it corrupts Windows paths like C:\buildAgent
function Get-PropsDictFromJavaPropsFile ($configFile) {
    # Returns configProps ordered dict
    $config = Get-Content $configFile
    Write-Verbose "$config"
    $configProps = [ordered]@{}
    $config | %{if (`
                            (!($_.StartsWith('#')))`
                                -and (!($_.StartsWith(';')))`
                                -and (!($_.StartsWith(";")))`
                                -and (!($_.StartsWith('`')))`
                                -and (($_.Contains('=')))){
                                    $props = @()
                                    $props = $_.split('=',2)
                                    Write-Verbose "Props are $props"
                                    $configProps.add($props[0],$props[1])
                            }
                    }
    return $configProps
}
$installParametersFile = "$toolsDir/install-parameters.txt"
$installParameters = Get-PropsDictFromJavaPropsFile $installParametersFile
$installParameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$agentDir = $installParameters["agentDir"]
$agentName = $installParameters["agentName"]
$agentDrive = split-path $agentDir -qualifier

$workingDirectory = Join-Path $agentDir "bin"
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.stop.bat -Wait"
Sleep 2
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.uninstall.bat -Wait"
tools\chocolateyInstall.ps1

$ErrorActionPreference = 'Stop'; # stop on all errors

if ($env:chocolateyPackageParameters -eq $null) {
	throw "No parameters have been passed into Chocolatey install, e.g. -params 'serverUrl=http://... agentName=... agentDir=... serviceAccount=... serviceAccountPassword=...'"
}

$parameters = ConvertFrom-StringData -StringData $env:chocolateyPackageParameters.Replace(" ", "`n")

## Validate parameters
if ($parameters["serverUrl"] -eq $null) {
    throw "Please specify the TeamCity server URL by passing it as a parameter to Chocolatey install, e.g. -params 'serverUrl=http://...'"
}
if ($parameters["agentDir"] -eq $null) {
    $parameters["agentDir"] = "$env:SystemDrive\buildAgent"
    Write-Host No agent directory is specified. Defaulting to $parameters["agentDir"]
}
if ($parameters["agentName"] -eq $null) {
    $defaultName = $true
    $parameters["agentName"] = "$env:COMPUTERNAME"
    Write-Host No agent name is specified. Defaulting to $parameters["agentName"]
}
if ($parameters["ownPort"] -eq $null) {
    $parameters["ownPort"] = "9090"
    Write-Host No agent port is specified. Defaulting to $parameters["ownPort"]
}

if ($parameters["serviceAccount"] -eq $null) {
    $defaultServiceAccount = $true
    Write-Host No service account provided, will run as system account.
}

$packageName = "TeamCityAgent"
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

## Make local variables of it
$serverUrl = $parameters["serverUrl"];
$agentDir = $parameters["agentDir"];
$agentName = $parameters["agentName"];
$ownPort = $parameters["ownPort"];
$serviceAccount = $parameters["serviceAccount"];
$serviceAccountPassword = $parameters["serviceAccountPassword"];
$agentDrive = split-path $agentDir -qualifier

# Write out the install parameters to a file for reference during upgrade/uninstall
# This doesn't currently preserve anything during an upgrade, it just helps locate the service control batch files
$parameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$parameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Out-File "$toolsDir/install-parameters.txt" -Encoding ascii

$packageArgs = @{
  packageName   = "$packageName"
  unzipLocation = "$agentDir"
  url           = "$serverUrl/update/buildAgent.zip"
}
Install-ChocolateyZipPackage @packageArgs

# Generic function to read Java properties file into ordered dict
function Get-PropsDictFromJavaPropsFile ($configFile) {
    # Returns configProps ordered dict
    $config = Get-Content $configFile
    Write-Verbose "$config"
    $configProps = [ordered]@{}
    # The 'if' block lines strip comments to avoid invalid/duplicate key issues
    $config | %{if (`
                            (!($_.StartsWith('#')))`
                                -and (!($_.StartsWith(';')))`
                                -and (!($_.StartsWith(";")))`
                                -and (!($_.StartsWith('`')))`
                                -and (($_.Contains('=')))){
                                    $props = @()
                                    $props = $_.split('=',2)
                                    # Use Write-Host or Write-Verbose, Write-Output appends to the return value and breaks things
                                    Write-Verbose "Props are $props"
                                    $configProps.add($props[0],$props[1])
                            }
                    }
    return $configProps
}

# Configure agent
$buildAgentDistFile = "$agentDir\conf\buildAgent.dist.properties"
$buildAgentPropFile = "$agentDir\conf\buildAgent.properties"

if ($ownPort -eq "9090") {
	# Simply replace config elements since we aren't adding any new entries
	(Get-Content $buildAgentDistFile) | Foreach-Object {
		$_ -replace 'serverUrl=(?:\S+)', "serverUrl=$serverUrl" `
		   -replace 'name=(?:\S+|$)', "name=$agentName"
		} | Set-Content $buildAgentPropFile
} else {
    # Since we are adding a new element and this can be tricky to get right
    # this rewrites the entire config without comments and updated values
    $buildAgentProps = Get-PropsDictFromJavaPropsFile $buildAgentDistFile

    Write-Verbose "Build Agent original settings"
    $buildAgentProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose

    # Set values that require customization
    $buildAgentProps['serverUrl'] = $serverUrl
    $buildAgentProps['name'] = $agentName
    $buildAgentProps['ownPort'] = $ownPort

    Write-Verbose "Build Agent updated settings"
    $buildAgentProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
    $buildAgentProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Out-File $buildAgentPropFile -Encoding 'ascii'
}

# This rewrites the wrapper config file without comments, if you need the comments,
# don't supply an agentName or serviceAccount when installing to get the default config
if (-Not ($defaultName -eq $true -And $defaultServiceAccount -eq $true)) {
    $wrapperPropsFile = "$agentDir\launcher\conf\wrapper.conf"
    $wrapperProps = Get-PropsDictFromJavaPropsFile $wrapperPropsFile

    Write-Verbose "Java Service Wrapper original settings"
    $wrapperProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
    # Supplying a custom agentName allows multiple instances on a single machine
    if (-Not ($defaultName -eq $true -Or $agentName -eq "")) {
        $wrapperProps['wrapper.ntservice.name'] = "$agentName"
        $wrapperProps['wrapper.ntservice.displayname'] = "$agentName TeamCity Build Agent"
        $wrapperProps['wrapper.ntservice.description'] = "$agentName TeamCity Build Agent Service"
    }
    if($serviceAccount -ne $null){
        $wrapperProps['wrapper.ntservice.account'] = "$serviceAccount"
    }
    if($serviceAccountPassword -ne $null){
        $wrapperProps['wrapper.ntservice.password'] = "$serviceAccountPassword"
    }

    Write-Verbose "Java Service Wrapper updated settings"
    $wrapperProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
    $wrapperProps.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Out-File $wrapperPropsFile -Encoding 'ascii'
}

# TODO: catch failure and call chocolateyUninstall.ps1 or some other cleanup
$workingDirectory = Join-Path $agentDir "bin"
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.install.bat -Wait"
Sleep 2
Start-ChocolateyProcessAsAdmin "Set-Location $workingDirectory; Start-Process -FilePath .\service.start.bat -Wait"
tools\chocolateyuninstall.ps1

$ErrorActionPreference = 'Stop'; # stop on all errors

$packageName = 'TeamCityAgent'
$zipFileName = 'buildAgent.zip'

$uninstalled = $false
Uninstall-ChocolateyZipPackage -PackageName $packageName `
                                -ZipFileName  $zipFileName

$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
# Don't use ConvertFrom-StringData as it corrupts Windows paths like C:\buildAgent
function Get-PropsDictFromJavaPropsFile ($configFile) {
    # Returns configProps ordered dict
    $config = Get-Content $configFile
    Write-Verbose "$config"
    $configProps = [ordered]@{}
    $config | %{if (`
                            (!($_.StartsWith('#')))`
                                -and (!($_.StartsWith(';')))`
                                -and (!($_.StartsWith(";")))`
                                -and (!($_.StartsWith('`')))`
                                -and (($_.Contains('=')))){
                                    $props = @()
                                    $props = $_.split('=',2)
                                    Write-Verbose "Props are $props"
                                    $configProps.add($props[0],$props[1])
                            }
                    }
    return $configProps
}
$installParametersFile = "$toolsDir/install-parameters.txt"
$installParameters = Get-PropsDictFromJavaPropsFile $installParametersFile
$installParameters.GetEnumerator() | % { "$($_.Name)=$($_.Value)" } | Write-Verbose
$agentDir = $installParameters["agentDir"]
if (Test-Path $agentDir) {
    "Removing $agentDir"
    Remove-Item $agentDir -force -recurse
}

$uninstalled = $true

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
TeamCity Build Agent 3.0.1 6200 Tuesday, January 22, 2019 Approved
TeamCity Build Agent 3.0.0 8576 Thursday, January 17, 2019 Approved
TeamCity Build Agent 3.0.0-beta-2 61 Thursday, January 17, 2019 Approved
TeamCity Build Agent 3.0.0-beta-1 54 Thursday, January 17, 2019 Approved
TeamCity Build Agent 2.3.0-beta-1 183 Wednesday, July 11, 2018 Approved
TeamCity Build Agent 2.2.1 203552 Friday, April 13, 2018 Approved
TeamCity Build Agent 2.1.2 19649 Thursday, October 19, 2017 Approved
TeamCity Build Agent 2.1.1 12143 Tuesday, August 1, 2017 Approved
TeamCity Build Agent 2.1.0 214 Wednesday, July 19, 2017 Approved

Version 3.x of this package uses AdoptOpenJDK. Version 4.x depends on Chocolatey 0.10.14.


Discussion for the TeamCity Build Agent Package

Ground Rules:

  • This discussion is only about TeamCity Build Agent and the TeamCity Build Agent package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or TeamCity Build Agent, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus