Skip to content

Latest commit

 

History

History
376 lines (299 loc) · 16.5 KB

getting-started-win.adoc

File metadata and controls

376 lines (299 loc) · 16.5 KB
Raw

Getting started with fabric8-auth development on Windows

This page explains how to get the software you need to use a Windows 10 64 bit machine for fabric8-auth development. In addition to that this page lists steps how to configure your development environment in terms of setting Windows environment variables.

Note
 In this guide we assume that the drive where your home folder is located is c:. Please adjust this to your needs whenever your home folder is on another drive.

Whenever you have problems with this setup you might find an answer in the Troubleshooting section.

Table of Contents

1. Introduction

To start developing on Windows you must:

After that you have to configure various things

As a final step we install a debugger. This requires some preparation and that’s why we do it as one of the last steps.

To get the code and build it, look here:

1.1. Install Git

  1. Browse to the Git download page.

  2. If your download doesn’t start automatically click the 64-bit Git for Windows Setup. link. Windows prompts you to save the file to your machine. The exact location isn’t important.

  3. Run the saved file.

  4. The system displays the Git Setup wizard.

  5. Click the Next button to move through the wizard and accept all the defaults.

  6. Click Finish when you are done.

1.2. Install Mercurial

  1. Browse to the Mercurial download page.

  2. Find the download entitled Mercurial 3.9 Inno Setup installer - x64 Windows - does not require admin rights and click on download. The version can be higher than 3.9 but don’t worry.

  3. Windows prompts you to save the file to your machine. The exact location isn’t important.

  4. Run the saved file.

  5. The system displays the Mercurial Setup Wizard.

  6. On the License Agreement page select I accept the agreement.

  7. Click the Next button to get to the page Select Destination Directory.

  8. Enter C:\Users\YOURNAME\mercurial` as the destination directory and replace YOURNAME with your winows login name.

  9. Click Next to get to the page Select Start Menu Folder.

  10. Click Next to get to the page Ready to Install.

  11. Click Install to get to the page Information.

  12. Click Next to get to the page Completing the Mercurial Setup.

  13. Make sure the box Add the installation path to the search path is checked.

  14. Click Finish when you are done.

1.3. Install Glide

In Go third-party packages are typically searched for inside a special directory. If a required package is not there, it will be downloaded using go get. While this seems handy at first it can have a serious drawback: you cannot specify which version of the package to download. This can lead to problems when a required package changes its interface that your code relies on. To overcome this , we use a tool called glide to download required packages in exactly specified versions and install them in a vendor directory right next to our source code under.

  1. Browse to the Glide release download page.

  2. Under Release 0.11.1 (or newer) click on the link that says: glide-v0.11.1-windows-amd64.zip. (e.g. download Glide 0.11.1)

  3. Windows prompts you to save the file to your machine. The exact location isn’t important.

  4. Right click the downloaded file and select extract all.

  5. Enter c:\Users\YOURNAME\glide as destination and replace YOURNAME with your winows login name.

  6. Click extract.

  7. The glide.exe binary is now located under C:\Users\YOURNAME\glide\windows-amd64\glide.exe

1.4. Install Go

  1. Browse to the Go download page.

  2. Under Featured downloads click on the one that says: Microsoft Windows. (e.g. download Go 1.7.4)

  3. Windows prompts you to save the file to your machine. The exact location isn’t important.

  4. Run the saved file.

  5. The system displays the Go Setup Wizard.

  6. Click the Next button to move through the wizard and accept all the defaults.

  7. Click Install to install Go.

  8. Click Finish when you are done.

1.5. Install Cygwin

Cygwin is:

  • a large collection of GNU and Open Source tools which provide functionality similar to a Linux distribution on Windows.

  • a DLL (cygwin1.dll) which provides substantial POSIX API functionality.

Follow these steps to install cygwin:

  1. Browse to the Cygwin download page.

  2. Windows prompts you to save the file to your machine. The exact location isn’t important.

  3. Run the saved file.

  4. The system displays the Go Setup Wizard.

  5. Click the Next button once to get to the page Choose A Download Source.

  6. Select Install from Internet (if not already selected).

  7. Click Next to get to the page Select Root Installation Directory.

  8. Enter C:\Users\YOURNAME\cygwin as Root Directory and replace YOURNAME with your Windows username.

  9. Under Install for select All users (if not already selected).

  10. Click Next to get to the page Select Local Package Directory.

  11. Enter C:\Users\YOURNAME\AppData\Local\Temp as Local Package Directory and replace YOURNAME with your Windows username.

  12. Click Next to get to the page Select Your Internet Connection.

  13. Select Direct Connection (if not already selected). If you have a more exotic connection (like in a univeristy or school), you might need to adjust proxy setting here but in most cases this is not needed.

  14. Click Next to get to the page Choose A Download Site.

  15. If you don’t have an extremly slow internet connection you can leave everything untouched. Otherwise you can pick an Available Download Site that’s more close to you than the default http://cygwin.mirror.constant.com.

  16. Click Next to get to the Select Packages Page.

  17. In the Search field enter make to filter the packages.

  18. Unfold the Devel section by clicking on the little + symbol.

  19. In the Package column look for make: The GNU version of the 'make' utility and click the Skip text in the New column. This should render the Bin? column on this line to be a checked box. The Skip text should also disappear and instead render a version string like 4.2.1-1.

  20. Click Next to get to the page Resolving Dependencies page.

  21. Click Next to download and install the packages.

  22. Click Finish when you are done.

2. Configure Git

Whenever you make a commit using Git, you want to make sure that it’s clear who the author is. To address this, follow these easy steps:

  1. Hit the Windows key on your keyboard and type git bash to start searching for the Git Bash application.

  2. Hit Enter.

  3. Set your username by entering

    git config --global user.name "YOUR NAME"

    after the $ character and replace YOUR NAME with your own name.

  4. Set your email address by entering

    git config --global user.email "[email protected]"

    after the $ character and replace [email protected] with your own email address.

  5. You can close the git bash now by either clicking the X or typing Ctrl+d.

3. Configure Windows environment variables

3.1. Add glide to PATH

Important
 Before you continue, close any existing Windows Command Prompt (or at least close the one you’ve opened while working through this document). This is important because otherwise the environment variables that we have modified won’t be available.

To be able to launch glide.exe from any location using the Windows Command Prompt we’ll have to add the path to the executable, namely C:\Users\YOURNAME\glide\windows-amd64 to the Windows user’s PATH variable or create a new PATH variable.

  1. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  2. We will add the path to glide.exe to an environment variable called PATH now or created it if it doesn’t already exist. Check if your user already has set a PATH variable by typing

    echo %PATH%

    and hit Enter.

    1. If the output is %PATH% then you have not yet set a PATH variable and we can continue by typing

      setx PATH "%HOMEDRIVE%\%HOMEPATH%\glide\windows-amd64"

      and hit Enter.

    2. If the output is something different from %PATH% then we have to append the path C:\Users\YOURNAME\glide\windows-amd64 by setting the PATH variable and separating the already existing paths using a semicolon:

      setx PATH "%PATH%;%HOMEDRIVE%\%HOMEPATH%\glide\windows-amd64"

3.2. Create GOPATH

Important
 Before you continue, close any existing Windows Command Prompt (or at least close the one you’ve opened while working through this document). This is important because otherwise the environment variables that we have modified won’t be available.

Typically, Go projects are checked out under a special directory which is commonly known as GOPATH. The fabric8-auth project makes not exception here. In most of the documentation that is written for Linux or MacOSX you will find us referencing this path as $GOPATH. On Windows this translates to %GOPATH%.

Now you may already have guessed this but %GOPATH% is also an environment variable that contains a path (sometimes a list of paths separated by semicolons) to various locations that will all be treated as `GOPATH`s by Go.

Depending on your configuration we will either have to create a GOPATH environment variable or re-use an existing one.

  1. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  2. Check if your user already has set a GOPATH variable by typing

    echo %GOPATH%

    1. If the output is %GOPATH% then you have not yet set a GOPATH variable and we can continue by typing

      setx GOPATH "%HOMEDRIVE%\%HOMEPATH%\go"

      The variable %HOMEPATH% expands to your user’s directory (e.g. \Users\John) and %HOMEDRIVE% expands to c: for example.

    2. If the output is something different from %GOPATH% then we have to append the path %HOMEDRIVE%\%HOMEPATH%\go by setting the GOPATH variable and separating the already existing paths using a semicolon:

      setx GOPATH "%GOPATH%;%HOMEDRIVE%\%HOMEPATH%\go"

3.3. Add GOPATH\bin to PATH

Important
 Before you continue, close any existing Windows Command Prompt (or at least close the one you’ve opened while working through this document). This is important because otherwise the environment variables that we have modified won’t be available.

When you fetch go packages using go get you might end up having executables from these packages living under your %GOPATH% in a bin folder. It is common to add this directory to your %PATH% variable like we did in [add-glide-to-path].

  1. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  2. Next type in this command

    setx PATH "%PATH%;%GOPATH%\bin"

    and hit Enter.

3.4. Troubleshooting

Problem

  • When running the setx command in the Command Prompt, Windows tells me this WARNING: The data being saved is truncated to 1024 characters.

Solution

  • Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt.

  • Right click on the symbol and click on Start as administrator.

  • Repeat the setx command that wasn’t working before and add the /M option. This will modify the system-wide environment variable which is why you need admin rights to do this. For example: setx /M PATH "%PATH%;%GOPATH%\bin%".

3.5. Evaluation

Important
 Before you continue, close any existing Windows Command Prompt (or at least close the one you’ve opened while working through this document). This is important because otherwise the environment variables that we have modified won’t be available.

  1. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  2. Make sure we can find git, mercurial (hg command), glide, and go: Execute the commands from these lines one by one

    git --version
hg --version
glide --version
go version

  3. Check that the output looks something like this:

    git version 2.9.2.windows.1

Mercurial Distributed SCM (version 3.9)
(see https://mercurial-scm.org for more information)

Copyright (C) 2005-2016 Matt Mackall and others
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

glide version v0.11.1

go version go1.7.4 windows/amd64

4. Install delve

Delve is a debugger for the Go programming language.

  1. Make sure you’ve completed the steps in Configure Windows environment variables.

  2. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  3. Run this command to install delve and make it available through the dlv command:

    go get github.com/derekparker/delve/cmd/dlv

  4. Test that the dlv command can be found by typing:

    dlv version

    You should see something like this:

    Delve Debugger
Version: 0.11.0-alpha
Build:

5. Get the code

  1. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  2. Run this command to clone the fabric8-auth project into the correct folder that we’ve prepared in Create GOPATH.

    git clone https://github.com/fabric8-services/fabric8-auth.git %HOMEDRIVE%\%HOMEPATH%\go\src\github.com\fabric8-services/fabric8-auth

6. Fetch dependencies

  1. Hit the Windows key on your keyboard and type cmd.exe to start searching for the Windows Command Prompt. Hit Enter.

  2. Navigate to the source directory by running

    cd %HOMEDRIVE\%HOMEPATH%\go\src\github.com\fabric8-services\fabric8-auth

  3. Fetch the Go packages that this project depends on by running

    glide install

    This command could take a while to finish. After that, the dependencies are stored in %HOMEDRIVE\%HOMEPATH%\go\src\github.com\fabric8-services\fabric8-auth\vendor.

7. Build from source

Note
 Make sure that you’ve followed the procedures in Get the code and Fetch dependencies before you continue.

To build the source we use the Cygwin64 Terminal that we’ve installed in Install Cygwin. That terminal behaves more like a Bash on Linux than the Windows Commmand Prompt. But don’t worry, this is fine.

Note
 In the Windows Command Prompt each environment variable is accessible by typing echo %VAR%, whereas in the Cygwin64 Terminal we have to type echo $VAR. Please note, that only one prefixing character ($) is needed.
Note
 Unlike the Windows Command Prompt, Cygwin64 Terminal can only handle forward slashes in paths. This is why you will see us converting our environment variables using a path converting tool, namely cygpath.

  1. Hit the Windows key on your keyboard and type cygwin to start searching for the Cygwin64 Terminal. Hit Enter.

  2. Navigate to the source directory

    cd "$(cygpath --unix $HOMEPATH)/go/src/github.com/fabric8-services/fabric8-auth"

  3. Now, generate code from the design templates using Goa:

    PATH="$PATH:$(cygpath --unix "C:/Users/$USER/mercurial")" make generate

  4. Build the the server and client component:

    PATH="$PATH:$(cygpath --unix "C:/Users/$USER/mercurial")" make build

  5. Run the unit tests

    PATH="$PATH:$(cygpath --unix "C:/Users/$USER/mercurial")" make test-unit