Go to file
2015-11-06 15:21:39 -08:00
docs Updated Native Tests.md 2015-10-16 22:55:43 +00:00
ext-src Update cppunit and pester 2015-10-22 09:47:54 -07:00
src fixed broken tests; the issue here is that powershell scoping is difficult for testing in pester 2015-11-06 15:21:39 -08:00
tools Start build refactor with top-level Makefile 2015-10-25 20:37:36 -07:00
.gitignore Start build refactor with top-level Makefile 2015-10-25 20:37:36 -07:00
.gitmodules Track develop branch of monad-native 2015-10-30 10:56:31 -07:00
Makefile Prepend existing LD_LIBRARY_PATH 2015-11-04 15:09:29 -08:00
monad-docker.sh Fix monad-run 2015-11-04 15:09:29 -08:00
packages.config Add Json.NET Pester tests 2015-10-30 18:09:03 -07:00
README.md Update readme 2015-10-23 16:09:07 -07:00

PowerShell for Linux

Obtain the source code

Setup Git

Install Git, the version control system. If you're new to Git, peruse the documentation and go through some tutorials; I recommend familiarizing yourself with checkout, branch, pull, push, merge, and after a while, rebase and cherry-pick.

The user name and email must be set to do just about anything with Git.

git config --global user.name "First Last"
git config --global user.email "alias@microsoft.com"

I highly recommend these configurations to help deal with whitespace, rebasing, and general use of Git.

Auto-corrects your command when it's sure (stats to status)

git config --global help.autoCorrect -1

Refuses to merge when pulling, and only pushes to branch with same name.

git config --global pull.ff only
git config --global push.default current

Shows shorter commit hashes and always shows reference names in the log.

git config --global log.abbrevCommit true
git config --global log.decorate short

Ignores whitespace changes and uses more information when merging.

git config --global apply.ignoreWhitespace change
git config --global rerere.enabled true
git config --global rerere.autoUpdate true
git config --global am.threeWay true

Setup Visual Studio Online authentication

To use Git's https protocol with VSO, you'll want to setup tokens, and have Git remember them.

  1. git config --global credential.helper store
  2. Login to https://msostc.visualstudio.com
  3. Click your name in the upper left corner and click 'My profile'
  4. Click the "Security" tab in the left pane (under "Details")
  5. Click "Add"
  6. Enter "msostc" for "Description"
  7. Set "Expires In" to "1 year"
  8. Choose " msostc" for "Accounts"
  9. Choose "All scopes"
  10. Click "Create Token" (you may want to copy this token somewhere safe, as VSO will not show it again!)
  11. Use this token as the password when cloning (and your username for the username)

Download source code

Clone our monad-linux source from Visual Studio Online, it's the superproject with a number of submodules.

git clone --recursive https://msostc.visualstudio.com/DefaultCollection/PS/_git/monad-linux

Please read the documentation on submodules if you're not familiar with them.

Setup build environment

Docker

See the official installation documentation on how to install Docker, and don't forget to setup a Docker group.

The Docker container can be updated with docker pull andschwa/magrathea, which downloads it from the automated build repository.

This container isolates all our build dependencies, including Ubuntu 14.04 and Mono. See the Dockerfile to look under the hood.

The monad-docker.sh script has two Bash functions, monad-run and monad-tty, which are wrappers that start a temporary container with monad-linux mounted and runs the arguments given to the script as your current user, but inside the container. The build artifacts will exist in your local folder and be owned by your user, essentially making the use of the container invisible. The monad-tty version also allocates a shell for the container, and so allows you to launch Bash or an interactive PowerShell session. Since these are Bash functions, it is simplest to source the monad-docker.sh script directly in your ~/.bashrc, but the ./build.sh script will also source it and delegate to monad-run.

Building

  1. cd scripts since it contains the Makefile and monad-run.sh
  2. source monad-docker.sh to get the monad-run and monad-tty Bash functions
  3. monad-run make -j will build PowerShell for Linux, in parallel with -j
  4. monad-run make -j run will build and execute a demo, "a","b","c","a","a" | Select-Object -Unique
  5. monad-run make -j test will build PowerShell and execute the unit tests
  6. monad-tty make shell will open an interactive PowerShell console (note the tty)
  7. make clean will remove the PowerShell and CoreCLR execution environment exec_env
  8. make clean-native will remove libps
  9. make cleanall will do the above and also remove the NuGet packages in buildtemp

Adding Pester tests

Pester tests are located in the src/pester-tests folder. The makefile targets test and pester-tests will run all Pester tests.

The steps to add your pester tests are:

  • add *.Tests.ps1 files to src/pester-tests
  • run monad-run make pester-tests to run all the tests

TODO: Docker shell-in-a-box

TODO: Architecture