Skip to content

Latest commit

 

History

History
249 lines (193 loc) · 10.9 KB

building-code.md

File metadata and controls

249 lines (193 loc) · 10.9 KB
Raw

Building AutoRest

Build Prerequisites

AutoRest is developed primarily in C# but generates code for multiple languages. To build and test AutoRest requires a few things be installed locally.

Setting up for development on AutoRest.

Expected time around 100 minutes to install.

  • 90 minutes for VS Community
  • 10 minutes for everything else 😭

Software Installed/operations:

  • Windows 10 Anniversary - (has PackageManagement, developer mode and supports WSL.)
  • JDK 8
  • Android SDK
  • NodeJS
  • Gulp
  • Ruby 2.3
  • Ruby Devkit Including missing CA Roots for Ruby
  • Python 2.7
  • Python 3.5
  • Tox
  • Maven
  • Go
  • Glide
  • Git (copies git to x86 program files too. )
  • allows java, node, ruby, go, glide thru the firewall.
  • vs community (full install) NOTE: If you want a different SKU of Visual Studio, install it first, before running this script!
  • disables strong name verification on assemblies
  • vs code
  • dotnet cli
  • Reboot

Process

  • Enable Developer Mode in win10 In Cortana, search for developer settings click "Developer Mode", answer "yes" scroll down, and click apply, apply, apply Close Settings. Reboot (win-r shutdown -r -t 0)

  • After Reboot, login then: Win-x , cmd prompt (admin) -- (ELEVATED!) start Powershell and run this command:

See the actual script at: https://github.com/Azure/autorest/blob/master/Tools/setup-developerworkstation.ps1

   # download the install script and run it.
   iwr https://raw.githubusercontent.com/Azure/autorest/master/Tools/setup-developerworkstation.ps1 -OutFile c:\install-software.ps1 ; c:\install-software.ps1

After this script finishes, you're done! No need to go through the instructions for manual setup.

Manual Setup

.Net

on Windows

Install the Microsoft Build Tools or get them with Visual Studio. Ensure that msbuild is in your path by running vcvarsall.bat

C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat

To compile the code in Visual Studio IDE,

  • Ensure you are using Visual Studio 2015 (Update 3)
  • Ensure "Nuget Package Manager For Visual Studio" is updated to a newest version, like "2.8.60723.765", which is needed to install xunit.
  • Install Task Runner Explorer to run gulp tasks such as synchonize nuget version, assembly info, etc.

Install .Net CoreCLR RTM using these steps.

Mac/Linux instructions are out of date, and will be updated soon.

Testing Your Environment

To make sure you've set up all the prerequisites correctly, run .\Tools\Verify-Settings.ps1 before you attempt to build.

Build

Visual Studio Build

AutoRest.sln is used to build AutoRest code generator.

###Command Line We use gulp and msbuild / xbuild to handle the builds. Install for global use with

npm install gulp -g

gulp

If you would like to see what commands are available to you, run gulp -T. That will list all of the gulp tasks you can run. By default, just running gulp will run a build that will execute clean, build, code analysis, package and test.

Output from gulp -T

[13:54:21] Using gulpfile ./autorest/gulpfile.js
[13:54:21] Tasks for ./autorest/gulpfile.js
[13:54:21] ├── regenerate:expected
[13:54:21] ├── regenerate:delete
[13:54:21] ├── regenerate:expected:csazure
[13:54:21] ├── regenerate:expected:cs
[13:54:21] ├── clean:build
[13:54:21] ├── clean:templates
[13:54:21] ├── clean:generatedTest
[13:54:21] ├─┬ clean
[13:54:21] │ ├── clean:build
[13:54:21] │ ├── clean:templates
[13:54:21] │ └── clean:generatedTest
[13:54:21] ├── syncNugetProjs
[13:54:21] ├── syncNuspecs
[13:54:21] ├─┬ syncDotNetDependencies
[13:54:21] │ ├── syncNugetProjs
[13:54:21] │ └── syncNuspecs
[13:54:21] ├── build
[13:54:21] ├── package
[13:54:21] ├── test
[13:54:21] ├── analysis
[13:54:21] └── default

Running the tests

Prior to executing gulp to build and then test the code, make sure that the latest tools are setup for your build environment.

gulp test

Troubleshooting

Strong Name Validation Errors

If you're running Windows and get errors like this while building:

Unhandled Exception: System.IO.FileLoadException: Could not load file or assembly 'AutoRest, Version=0.17.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35' or one of its dependencies. Strong name validation failed. (Exception from HRESULT: 0x8013141A) ---> System.Security.SecurityException: Strong name validation failed. (Exception from HRESULT: 0x8013141A)

It means you need to disable strong name validation on your dev box:

"C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.6.1 Tools\sn.exe" -Vr * "C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.6.1 Tools\x64\sn.exe" -Vr *

Running AutoRest

Command Line

After building, the AutoRest.exe executable will be output to the /binaries/net45/ folder. You can run it with the command line options specified in the Command Line Interface documentation.

Visual Studio

You can run (and debug) AutoRest by providing the command line parameters in the properties for the AutoRest project. To set these:

  1. Open the properties for the AutoRest project.
  2. Select the Debug tab.
  3. Set the Command line arguments field in the Start Options section.
  4. Build the entire solution to make sure the generators and modelers are built.
  5. F5 the project.

Troubleshooting

#####If the task runner window in Visual Studio does not show any tasks Make sure that you have run npm install in the root folder.

#####If AutoRest.exe complains about not having generators for each language Make sure that you have built the entire AutoRest.sln solution.

#####If you see the error gulp is not recognized as an internal or external command gulp is located at C:\Users\[user]\AppData\Roaming\npm\gulp in Windows after you install it globally.

Releasing AutoRest

  • Merge pending PRs into the master branch
  • Create a release branch from master
  • Update Changelog.md
  • Publish .NET Runtimes (increment versions as appropriate) using automated build
  • Publish Node Runtimes (increment versions as appropriate)
  • Publish Java Runtimes (increment versions as appropriate)
  • Publish Ruby Runtimes (increment versions as appropriate)
  • Publish Python Runtimes (increment versions as appropriate)
  • Create a signed package using automated build with build parameters: sha1: release branch name, scope: CodeGenerator
  • Smoke Test the signed package (Run Autorest.exe to check help and generate a sample spec for any language)
  • Publish Choco package {upload autorest.0.15.0.symbols.nupkg from the downloaded archive of the successful signing job}(Please look at the secure notebook for creds)
  • Publish nuget package using automated build
  • Create a github release from the release branch including a tag
  • Add -SNAPSHOT to Java Runtime versions
  • Update Docker file in the release branch
  • Add zip packages as a binary to the release
  • Copy over the changelog as release notes for github release
  • Publish the github release
  • Login to [dockerhub] (https://hub.docker.com/r/azuresdk/autorest/~/settings/automated-builds/) and trigger the build using the release tag (look at the secure notebook for creds)
  • Smoke test the nuget and npm packages
  • Merge release -> master
  • Bump up the version of autorest.exe
    • Update Assembly Info in AutoRest.Core
    • Update AutoRest.nuget.proj to build nightly using the next version
    • Run gulp syncDependencies from the root of the cloned AutoRest repository