make.ps1 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  1. <#
  2. .NOTES
  3. Author: @jhowardmsft
  4. Summary: Windows native build script. This is similar to functionality provided
  5. by hack\make.sh, but uses native Windows PowerShell semantics. It does
  6. not support the full set of options provided by the Linux counterpart.
  7. For example:
  8. - You can't cross-build Linux docker binaries on Windows
  9. - Hashes aren't generated on binaries
  10. - 'Releasing' isn't supported.
  11. - Integration tests. This is because they currently cannot run inside a container,
  12. and require significant external setup.
  13. It does however provided the minimum necessary to support parts of local Windows
  14. development and Windows to Windows CI.
  15. Usage Examples (run from repo root):
  16. "hack\make.ps1 -Binary" to build the binaries
  17. "hack\make.ps1 -Client" to build just the client 64-bit binary
  18. "hack\make.ps1 -TestUnit" to run unit tests
  19. "hack\make.ps1 -Binary -TestUnit" to build the binaries and run unit tests
  20. "hack\make.ps1 -All" to run everything this script knows about that can run in a container
  21. .PARAMETER Client
  22. Builds the client binaries.
  23. .PARAMETER Daemon
  24. Builds the daemon binary.
  25. .PARAMETER Binary
  26. Builds the client binaries and the daemon binary. A convenient shortcut to `make.ps1 -Client -Daemon`.
  27. .PARAMETER Race
  28. Use -race in go build and go test.
  29. .PARAMETER Noisy
  30. Use -v in go build.
  31. .PARAMETER ForceBuildAll
  32. Use -a in go build.
  33. .PARAMETER NoOpt
  34. Use -gcflags -N -l in go build to disable optimisation (can aide debugging).
  35. .PARAMETER CommitSuffix
  36. Adds a custom string to be appended to the commit ID (spaces are stripped).
  37. .PARAMETER DCO
  38. Runs the DCO (Developer Certificate Of Origin) test (must be run outside a container).
  39. .PARAMETER PkgImports
  40. Runs the pkg\ directory imports test (must be run outside a container).
  41. .PARAMETER GoFormat
  42. Runs the Go formatting test (must be run outside a container).
  43. .PARAMETER TestUnit
  44. Runs unit tests.
  45. .PARAMETER All
  46. Runs everything this script knows about that can run in a container.
  47. TODO
  48. - Unify the head commit
  49. - Add golint and other checks (swagger maybe?)
  50. #>
  51. param(
  52. [Parameter(Mandatory=$False)][switch]$Client,
  53. [Parameter(Mandatory=$False)][switch]$Daemon,
  54. [Parameter(Mandatory=$False)][switch]$Binary,
  55. [Parameter(Mandatory=$False)][switch]$Race,
  56. [Parameter(Mandatory=$False)][switch]$Noisy,
  57. [Parameter(Mandatory=$False)][switch]$ForceBuildAll,
  58. [Parameter(Mandatory=$False)][switch]$NoOpt,
  59. [Parameter(Mandatory=$False)][string]$CommitSuffix="",
  60. [Parameter(Mandatory=$False)][switch]$DCO,
  61. [Parameter(Mandatory=$False)][switch]$PkgImports,
  62. [Parameter(Mandatory=$False)][switch]$GoFormat,
  63. [Parameter(Mandatory=$False)][switch]$TestUnit,
  64. [Parameter(Mandatory=$False)][switch]$All
  65. )
  66. $ErrorActionPreference = "Stop"
  67. $pushed=$False # To restore the directory if we have temporarily pushed to one.
  68. # Utility function to get the commit ID of the repository
  69. Function Get-GitCommit() {
  70. if (-not (Test-Path ".\.git")) {
  71. # If we don't have a .git directory, but we do have the environment
  72. # variable DOCKER_GITCOMMIT set, that can override it.
  73. if ($env:DOCKER_GITCOMMIT.Length -eq 0) {
  74. Throw ".git directory missing and DOCKER_GITCOMMIT environment variable not specified."
  75. }
  76. Write-Host "INFO: Git commit ($env:DOCKER_GITCOMMIT) assumed from DOCKER_GITCOMMIT environment variable"
  77. return $env:DOCKER_GITCOMMIT
  78. }
  79. $gitCommit=$(git rev-parse --short HEAD)
  80. if ($(git status --porcelain --untracked-files=no).Length -ne 0) {
  81. $gitCommit="$gitCommit-unsupported"
  82. Write-Host ""
  83. Write-Warning "This version is unsupported because there are uncommitted file(s)."
  84. Write-Warning "Either commit these changes, or add them to .gitignore."
  85. git status --porcelain --untracked-files=no | Write-Warning
  86. Write-Host ""
  87. }
  88. return $gitCommit
  89. }
  90. # Utility function to get get the current build version of docker
  91. Function Get-DockerVersion() {
  92. if (-not (Test-Path ".\VERSION")) { Throw "VERSION file not found. Is this running from the root of a docker repository?" }
  93. return $(Get-Content ".\VERSION" -raw).ToString().Replace("`n","").Trim()
  94. }
  95. # Utility function to determine if we are running in a container or not.
  96. # In Windows, we get this through an environment variable set in `Dockerfile.Windows`
  97. Function Check-InContainer() {
  98. if ($env:FROM_DOCKERFILE.Length -eq 0) {
  99. Write-Host ""
  100. Write-Warning "Not running in a container. The result might be an incorrect build."
  101. Write-Host ""
  102. return $False
  103. }
  104. return $True
  105. }
  106. # Utility function to warn if the version of go is correct. Used for local builds
  107. # outside of a container where it may be out of date with master.
  108. Function Verify-GoVersion() {
  109. Try {
  110. $goVersionDockerfile=(Get-Content ".\Dockerfile" | Select-String "ENV GO_VERSION").ToString().Split(" ")[2]
  111. $goVersionInstalled=(go version).ToString().Split(" ")[2].SubString(2)
  112. }
  113. Catch [Exception] {
  114. Throw "Failed to validate go version correctness: $_"
  115. }
  116. if (-not($goVersionInstalled -eq $goVersionDockerfile)) {
  117. Write-Host ""
  118. Write-Warning "Building with golang version $goVersionInstalled. You should update to $goVersionDockerfile"
  119. Write-Host ""
  120. }
  121. }
  122. # Utility function to get the commit for HEAD
  123. Function Get-HeadCommit() {
  124. $head = Invoke-Expression "git rev-parse --verify HEAD"
  125. if ($LASTEXITCODE -ne 0) { Throw "Failed getting HEAD commit" }
  126. return $head
  127. }
  128. # Utility function to get the commit for upstream
  129. Function Get-UpstreamCommit() {
  130. Invoke-Expression "git fetch -q https://github.com/docker/docker.git refs/heads/master"
  131. if ($LASTEXITCODE -ne 0) { Throw "Failed fetching" }
  132. $upstream = Invoke-Expression "git rev-parse --verify FETCH_HEAD"
  133. if ($LASTEXITCODE -ne 0) { Throw "Failed getting upstream commit" }
  134. return $upstream
  135. }
  136. # Build a binary (client or daemon)
  137. Function Execute-Build($type, $additionalBuildTags, $directory) {
  138. # Generate the build flags
  139. $buildTags = "autogen"
  140. if ($Noisy) { $verboseParm=" -v" }
  141. if ($Race) { Write-Warning "Using race detector"; $raceParm=" -race"}
  142. if ($ForceBuildAll) { $allParm=" -a" }
  143. if ($NoOpt) { $optParm=" -gcflags "+""""+"-N -l"+"""" }
  144. if ($addtionalBuildTags -ne "") { $buildTags += $(" " + $additionalBuildTags) }
  145. # Do the go build in the appropriate directory
  146. # Note -linkmode=internal is required to be able to debug on Windows.
  147. # https://github.com/golang/go/issues/14319#issuecomment-189576638
  148. Write-Host "INFO: Building $type..."
  149. Push-Location $root\cmd\$directory; $global:pushed=$True
  150. $buildCommand = "go build" + `
  151. $raceParm + `
  152. $verboseParm + `
  153. $allParm + `
  154. $optParm + `
  155. " -tags """ + $buildTags + """" + `
  156. " -ldflags """ + "-linkmode=internal" + """" + `
  157. " -o $root\bundles\"+$directory+".exe"
  158. Invoke-Expression $buildCommand
  159. if ($LASTEXITCODE -ne 0) { Throw "Failed to compile $type" }
  160. Pop-Location; $global:pushed=$False
  161. }
  162. # Validates the DCO marker is present on each commit
  163. Function Validate-DCO($headCommit, $upstreamCommit) {
  164. Write-Host "INFO: Validating Developer Certificate of Origin..."
  165. # Username may only contain alphanumeric characters or dashes and cannot begin with a dash
  166. $usernameRegex='[a-zA-Z0-9][a-zA-Z0-9-]+'
  167. $dcoPrefix="Signed-off-by:"
  168. $dcoRegex="^(Docker-DCO-1.1-)?$dcoPrefix ([^<]+) <([^<>@]+@[^<>]+)>( \(github: ($usernameRegex)\))?$"
  169. $counts = Invoke-Expression "git diff --numstat $upstreamCommit...$headCommit"
  170. if ($LASTEXITCODE -ne 0) { Throw "Failed git diff --numstat" }
  171. # Counts of adds and deletes after removing multiple white spaces. AWK anyone? :(
  172. $adds=0; $dels=0; $($counts -replace '\s+', ' ') | %{
  173. $a=$_.Split(" ");
  174. if ($a[0] -ne "-") { $adds+=[int]$a[0] }
  175. if ($a[1] -ne "-") { $dels+=[int]$a[1] }
  176. }
  177. if (($adds -eq 0) -and ($dels -eq 0)) {
  178. Write-Warning "DCO validation - nothing to validate!"
  179. return
  180. }
  181. $commits = Invoke-Expression "git log $upstreamCommit..$headCommit --format=format:%H%n"
  182. if ($LASTEXITCODE -ne 0) { Throw "Failed git log --format" }
  183. $commits = $($commits -split '\s+' -match '\S')
  184. $badCommits=@()
  185. $commits | %{
  186. # Skip commits with no content such as merge commits etc
  187. if ($(git log -1 --format=format: --name-status $_).Length -gt 0) {
  188. # Ignore exit code on next call - always process regardless
  189. $commitMessage = Invoke-Expression "git log -1 --format=format:%B --name-status $_"
  190. if (($commitMessage -match $dcoRegex).Length -eq 0) { $badCommits+=$_ }
  191. }
  192. }
  193. if ($badCommits.Length -eq 0) {
  194. Write-Host "Congratulations! All commits are properly signed with the DCO!"
  195. } else {
  196. $e = "`nThese commits do not have a proper '$dcoPrefix' marker:`n"
  197. $badCommits | %{ $e+=" - $_`n"}
  198. $e += "`nPlease amend each commit to include a properly formatted DCO marker.`n`n"
  199. $e += "Visit the following URL for information about the Docker DCO:`n"
  200. $e += "https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work`n"
  201. Throw $e
  202. }
  203. }
  204. # Validates that .\pkg\... is safely isolated from internal code
  205. Function Validate-PkgImports($headCommit, $upstreamCommit) {
  206. Write-Host "INFO: Validating pkg import isolation..."
  207. # Get a list of go source-code files which have changed under pkg\. Ignore exit code on next call - always process regardless
  208. $files=@(); $files = Invoke-Expression "git diff $upstreamCommit...$headCommit --diff-filter=ACMR --name-only -- `'pkg\*.go`'"
  209. $badFiles=@(); $files | %{
  210. $file=$_
  211. # For the current changed file, get its list of dependencies, sorted and uniqued.
  212. $imports = Invoke-Expression "go list -e -f `'{{ .Deps }}`' $file"
  213. if ($LASTEXITCODE -ne 0) { Throw "Failed go list for dependencies on $file" }
  214. $imports = $imports -Replace "\[" -Replace "\]", "" -Split(" ") | Sort-Object | Get-Unique
  215. # Filter out what we are looking for
  216. $imports = $imports -NotMatch "^github.com/docker/docker/pkg/" `
  217. -NotMatch "^github.com/docker/docker/vendor" `
  218. -Match "^github.com/docker/docker" `
  219. -Replace "`n", ""
  220. $imports | % { $badFiles+="$file imports $_`n" }
  221. }
  222. if ($badFiles.Length -eq 0) {
  223. Write-Host 'Congratulations! ".\pkg\*.go" is safely isolated from internal code.'
  224. } else {
  225. $e = "`nThese files import internal code: (either directly or indirectly)`n"
  226. $badFiles | %{ $e+=" - $_"}
  227. Throw $e
  228. }
  229. }
  230. # Validates that changed files are correctly go-formatted
  231. Function Validate-GoFormat($headCommit, $upstreamCommit) {
  232. Write-Host "INFO: Validating go formatting on changed files..."
  233. # Verify gofmt is installed
  234. if ($(Get-Command gofmt -ErrorAction SilentlyContinue) -eq $nil) { Throw "gofmt does not appear to be installed" }
  235. # Get a list of all go source-code files which have changed. Ignore exit code on next call - always process regardless
  236. $files=@(); $files = Invoke-Expression "git diff $upstreamCommit...$headCommit --diff-filter=ACMR --name-only -- `'*.go`'"
  237. $files = $files | Select-String -NotMatch "^vendor/" | Select-String -NotMatch "^cli/compose/schema/bindata.go"
  238. $badFiles=@(); $files | %{
  239. # Deliberately ignore error on next line - treat as failed
  240. $content=Invoke-Expression "git show $headCommit`:$_"
  241. # Next set of hoops are to ensure we have LF not CRLF semantics as otherwise gofmt on Windows will not succeed.
  242. # Also note that gofmt on Windows does not appear to support stdin piping correctly. Hence go through a temporary file.
  243. $content=$content -join "`n"
  244. $content+="`n"
  245. $outputFile=[System.IO.Path]::GetTempFileName()
  246. if (Test-Path $outputFile) { Remove-Item $outputFile }
  247. [System.IO.File]::WriteAllText($outputFile, $content, (New-Object System.Text.UTF8Encoding($False)))
  248. $currentFile = $_ -Replace("/","\")
  249. Write-Host Checking $currentFile
  250. Invoke-Expression "gofmt -s -l $outputFile"
  251. if ($LASTEXITCODE -ne 0) { $badFiles+=$currentFile }
  252. if (Test-Path $outputFile) { Remove-Item $outputFile }
  253. }
  254. if ($badFiles.Length -eq 0) {
  255. Write-Host 'Congratulations! All Go source files are properly formatted.'
  256. } else {
  257. $e = "`nThese files are not properly gofmt`'d:`n"
  258. $badFiles | %{ $e+=" - $_`n"}
  259. $e+= "`nPlease reformat the above files using `"gofmt -s -w`" and commit the result."
  260. Throw $e
  261. }
  262. }
  263. # Run the unit tests
  264. Function Run-UnitTests() {
  265. Write-Host "INFO: Running unit tests..."
  266. $testPath="./..."
  267. $goListCommand = "go list -e -f '{{if ne .Name """ + '\"github.com/docker/docker\"' + """}}{{.ImportPath}}{{end}}' $testPath"
  268. $pkgList = $(Invoke-Expression $goListCommand)
  269. if ($LASTEXITCODE -ne 0) { Throw "go list for unit tests failed" }
  270. $pkgList = $pkgList | Select-String -Pattern "github.com/docker/docker"
  271. $pkgList = $pkgList | Select-String -NotMatch "github.com/docker/docker/vendor"
  272. $pkgList = $pkgList | Select-String -NotMatch "github.com/docker/docker/man"
  273. $pkgList = $pkgList | Select-String -NotMatch "github.com/docker/docker/integration-cli"
  274. $pkgList = $pkgList -replace "`r`n", " "
  275. $goTestCommand = "go test" + $raceParm + " -cover -ldflags -w -tags """ + "autogen daemon" + """ -a """ + "-test.timeout=10m" + """ $pkgList"
  276. Invoke-Expression $goTestCommand
  277. if ($LASTEXITCODE -ne 0) { Throw "Unit tests failed" }
  278. }
  279. # Start of main code.
  280. Try {
  281. Write-Host -ForegroundColor Cyan "INFO: make.ps1 starting at $(Get-Date)"
  282. # Get to the root of the repo
  283. $root = $(Split-Path $MyInvocation.MyCommand.Definition -Parent | Split-Path -Parent)
  284. Push-Location $root
  285. # Handle the "-All" shortcut to turn on all things we can handle.
  286. # Note we expressly only include the items which can run in a container - the validations tests cannot
  287. # as they require the .git directory which is excluded from the image by .dockerignore
  288. if ($All) { $Client=$True; $Daemon=$True; $TestUnit=$True }
  289. # Handle the "-Binary" shortcut to build both client and daemon.
  290. if ($Binary) { $Client = $True; $Daemon = $True }
  291. # Default to building the binaries if not asked for anything explicitly.
  292. if (-not($Client) -and -not($Daemon) -and -not($DCO) -and -not($PkgImports) -and -not($GoFormat) -and -not($TestUnit)) { $Client=$True; $Daemon=$True }
  293. # Verify git is installed
  294. if ($(Get-Command git -ErrorAction SilentlyContinue) -eq $nil) { Throw "Git does not appear to be installed" }
  295. # Verify go is installed
  296. if ($(Get-Command go -ErrorAction SilentlyContinue) -eq $nil) { Throw "GoLang does not appear to be installed" }
  297. # Get the git commit. This will also verify if we are in a repo or not. Then add a custom string if supplied.
  298. $gitCommit=Get-GitCommit
  299. if ($CommitSuffix -ne "") { $gitCommit += "-"+$CommitSuffix -Replace ' ', '' }
  300. # Get the version of docker (eg 1.14.0-dev)
  301. $dockerVersion=Get-DockerVersion
  302. # Give a warning if we are not running in a container and are building binaries or running unit tests.
  303. # Not relevant for validation tests as these are fine to run outside of a container.
  304. if ($Client -or $Daemon -or $TestUnit) { $inContainer=Check-InContainer }
  305. # If we are not in a container, validate the version of GO that is installed.
  306. if (-not $inContainer) { Verify-GoVersion }
  307. # Verify GOPATH is set
  308. if ($env:GOPATH.Length -eq 0) { Throw "Missing GOPATH environment variable. See https://golang.org/doc/code.html#GOPATH" }
  309. # Run autogen if building binaries or running unit tests.
  310. if ($Client -or $Daemon -or $TestUnit) {
  311. Write-Host "INFO: Invoking autogen..."
  312. Try { .\hack\make\.go-autogen.ps1 -CommitString $gitCommit -DockerVersion $dockerVersion }
  313. Catch [Exception] { Throw $_ }
  314. }
  315. # DCO, Package import and Go formatting tests.
  316. if ($DCO -or $PkgImports -or $GoFormat) {
  317. # We need the head and upstream commits for these
  318. $headCommit=Get-HeadCommit
  319. $upstreamCommit=Get-UpstreamCommit
  320. # Run DCO validation
  321. if ($DCO) { Validate-DCO $headCommit $upstreamCommit }
  322. # Run `gofmt` validation
  323. if ($GoFormat) { Validate-GoFormat $headCommit $upstreamCommit }
  324. # Run pkg isolation validation
  325. if ($PkgImports) { Validate-PkgImports $headCommit $upstreamCommit }
  326. }
  327. # Build the binaries
  328. if ($Client -or $Daemon) {
  329. # Create the bundles directory if it doesn't exist
  330. if (-not (Test-Path ".\bundles")) { New-Item ".\bundles" -ItemType Directory | Out-Null }
  331. # Perform the actual build
  332. if ($Daemon) { Execute-Build "daemon" "daemon" "dockerd" }
  333. if ($Client) { Execute-Build "client" "" "docker" }
  334. }
  335. # Run unit tests
  336. if ($TestUnit) { Run-UnitTests }
  337. # Gratuitous ASCII art.
  338. if ($Daemon -or $Client) {
  339. Write-Host
  340. Write-Host -ForegroundColor Green " ________ ____ __."
  341. Write-Host -ForegroundColor Green " \_____ \ `| `|/ _`|"
  342. Write-Host -ForegroundColor Green " / `| \`| `<"
  343. Write-Host -ForegroundColor Green " / `| \ `| \"
  344. Write-Host -ForegroundColor Green " \_______ /____`|__ \"
  345. Write-Host -ForegroundColor Green " \/ \/"
  346. Write-Host
  347. }
  348. }
  349. Catch [Exception] {
  350. Write-Host -ForegroundColor Red ("`nERROR: make.ps1 failed:`n$_")
  351. # More gratuitous ASCII art.
  352. Write-Host
  353. Write-Host -ForegroundColor Red "___________ .__.__ .___"
  354. Write-Host -ForegroundColor Red "\_ _____/____ `|__`| `| ____ __`| _/"
  355. Write-Host -ForegroundColor Red " `| __) \__ \ `| `| `| _/ __ \ / __ `| "
  356. Write-Host -ForegroundColor Red " `| \ / __ \`| `| `|_\ ___// /_/ `| "
  357. Write-Host -ForegroundColor Red " \___ / (____ /__`|____/\___ `>____ `| "
  358. Write-Host -ForegroundColor Red " \/ \/ \/ \/ "
  359. Write-Host
  360. Throw $_
  361. }
  362. Finally {
  363. Pop-Location # As we pushed to the root of the repo as the very first thing
  364. if ($global:pushed) { Pop-Location }
  365. Write-Host -ForegroundColor Cyan "INFO: make.ps1 ended at $(Get-Date)"
  366. }