Notices: This section not yet converted to new layout. Download stats are rolling back out.

TeamCity Build Agent

3.0.1

This package skips automatic verification:

Requires Team City Server


This package was approved as a trusted package on 1/22/2019.

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.

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

C:\> choco install teamcityagent

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

C:\> choco upgrade teamcityagent

Files

Hide
  • tools\chocolateybeforemodify.ps1 Show
    $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
    
    Set-Location $agentDir\bin
    Start-ChocolateyProcessAsAdmin "Start-Process -FilePath .\service.stop.bat -Wait"
    Sleep 2
    Start-ChocolateyProcessAsAdmin "Start-Process -FilePath .\service.uninstall.bat -Wait"
  • tools\chocolateyInstall.ps1 Show
    $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
    Set-Location $agentDir\bin
    Start-ChocolateyProcessAsAdmin "Start-Process -FilePath .\service.install.bat -Wait"
    Sleep 2
    Start-ChocolateyProcessAsAdmin "Start-Process -FilePath .\service.start.bat -Wait"
  • tools\chocolateyuninstall.ps1 Show
    $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
    

Virus Scan Results

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.

Dependencies

Package Maintainer(s)

Software Author(s)

  • JetBrains

Copyright

JetBrains s.r.o.

Tags

Release Notes

Version 3.x of this package uses AdoptOpenJDK.

Version History

Version Downloads Last updated Status
TeamCity Build Agent 3.0.0 8521 Thursday, January 17, 2019 approved
TeamCity Build Agent 3.0.0-beta-2 24 Thursday, January 17, 2019 approved
TeamCity Build Agent 3.0.0-beta-1 21 Thursday, January 17, 2019 approved
TeamCity Build Agent 2.3.0-beta-1 144 Wednesday, July 11, 2018 approved
TeamCity Build Agent 2.2.1 203395 Friday, April 13, 2018 approved
TeamCity Build Agent 2.1.2 19603 Thursday, October 19, 2017 approved
TeamCity Build Agent 2.1.1 11737 Tuesday, August 1, 2017 approved
TeamCity Build Agent 2.1.0 183 Wednesday, July 19, 2017 approved
TeamCity Build Agent 2.0.1-beta-12 196 Wednesday, July 19, 2017 exempted
Show More

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
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok