Go to file
Andrew Schwartzmeyer fd782abe99 Make dotnet-nightly workaround version-agnostic
If the `Debug/dnxcore50` path does not exist, don't worry about it.
2016-01-29 17:24:49 -08:00
docs Document dependencies 2015-11-06 11:55:50 -08:00
src Bump monad and windows-build submodules 2016-01-26 17:00:13 -08:00
test Add packages required for updated sources 2016-01-26 16:49:28 -08:00
.gitignore Add TypeCatalogGen 2015-12-07 14:27:06 -08:00
.gitmodules Update OMI submodule's remote URL 2016-01-20 10:51:00 -08:00
.travis.yml Let Travis notify Slack 2016-01-22 15:05:57 -08:00
appveyor.yml Add AppVeyor CI integration. 2016-01-22 12:40:04 -08:00
build.ps1 Make dotnet-nightly workaround version-agnostic 2016-01-29 17:24:49 -08:00
build.sh Make dotnet-nightly workaround version-agnostic 2016-01-29 17:24:49 -08:00
CONTRIBUTING.md Note that CI gates pull requests 2016-01-29 09:33:27 -08:00
debug.sh Emit powershell executable 2016-01-19 12:56:56 -08:00
global.json Add global.json for dnu restore from root 2015-11-24 15:07:55 -08:00
KNOWNISSUES.md More readme updates 2016-01-20 12:29:06 -08:00
monad-docker.sh Add Docker user to sudo group 2015-11-23 17:54:30 -08:00
nuget.config Add packages required for updated sources 2016-01-26 16:49:28 -08:00
pester.sh Add test failure threshold to pester.sh 2016-01-22 14:32:04 -08:00
psrp.sh Add logging to PSRP script 2016-01-12 12:22:26 -08:00
README.md Link Waffle.io scrum board in readme 2016-01-25 10:38:35 -08:00

PowerShell on Linux / OS X / Windows

Ubuntu 14.04 Windows
master Build Status Build status

Waffle.io scrum board

Obtain the source code

Setup Git

Install Git, the version control system.

sudo apt-get install git

If you do not have a preferred method of authentication, enable the storage credential helper, which will cache your credentials in plaintext on your system, so use a token.

git config --global credential.helper store

See the Contributing Guidelines for more Git information.

Download source code

Clone this repository recursively, as it's the superproject with a number of submodules.

git clone --recursive https://github.com/PowerShell/PowerShell-Linux.git

The src/omi submodule requires your GitHub user to have joined the Microsoft organization. If it fails to check out, Git will bail and not check out further submodules either.

On Windows, many fewer submodules are needed, so don't use clone --recursive.

Instead run:

git clone https://github.com/PowerShell/PowerShell-Linux.git
git submodule update --init --recursive -- src/monad src/windows-build test/Pester

Setup build environment

We use the .NET Command Line Interface (dotnet-cli) to build the managed components, and CMake to build the native components (on non-Windows platforms). Install dotnet-cli by following their documentation (make sure to install the dotnet-nightly package on Linux to get the latest version).

Note that OS X dependency installation instructions are not yet documented, and Windows only needs dotnet-cli.

Previous installations of DNX or dnvm can cause dotnet-cli to fail.

Linux

Tested on Ubuntu 14.04.

sudo sh -c 'echo "deb [arch=amd64] http://apt-mo.trafficmanager.net/repos/dotnet/ trusty main" > /etc/apt/sources.list.d/dotnetdev.list'
sudo apt-key adv --keyserver apt-mo.trafficmanager.net --recv-keys 417A0893
sudo apt-get update
sudo apt-get install dotnet-nightly

Then install the following additional build / debug tools:

sudo apt-get install g++ cmake make lldb-3.6 strace

OMI

To develop on the PowerShell Remoting Protocol (PSRP) for Linux, you'll need to be able to compile OMI, which additionally requires:

sudo apt-get install libpam0g-dev libssl-dev libcurl4-openssl-dev libboost-filesystem-dev 

Building

The command dotnet restore must be done at least once from the top directory to obtain all the necessary .NET packages.

Build with ./build.sh on Linux and OS X, and ./build.ps1 on Windows.

Specifically:

Linux

In Bash:

cd PowerShell-Linux
dotnet restore
./build.sh

Windows

In PowerShell:

cd PowerShell-Linux
dotnet restore
./build.ps1

Running

If you encounter any problems, see the known issues, otherwise open a new issue on GitHub.

Linux / OS X

  • launch local shell with ./bin/powershell
  • launch local shell in LLDB with ./debug.sh
  • launch omiserver for PSRP (and in LLDB) with ./prsp.sh, and connect with Enter-PSSession from Windows

Windows

Launch ./bin/powershell.exe. The console output isn't the prettiest, but the vast majority of Pester tests pass. Run them in the console with Invoke-Pester test/powershell.

PowerShell Remoting Protocol

PSRP communication is tunneled through OMI using the omi-provider.

These build steps are not part of the ./build.sh script.

PSRP has been observed working on OS X, but the changes made to OMI to accomplish this are not even beta-ready and need to be done correctly. They exist on the andschwa-osx branch of the OMI repository.

Build OMI

cd src/omi/Unix
./configure --dev
make -j
cd ../../..

Build Provider

The provider uses CMake to build, link, and register with OMI.

cd src/omi-provider
cmake .
make -j
cd ../..

The provider also maintains its own native host library to initialize the CLR, but there are plans to refactor .NET's packaged host as a shared library.

Running

Some initial setup on Windows is required. Open an administrative command prompt and execute the following:

winrm set winrm/config/Client @{AllowUnencrypted="true"}
winrm set winrm/config/Client @{TrustedHosts="*"}

Then on Linux, launch omiserver in the debugger (after building with the instructions above):

./psrp.sh
run

The run command is executed inside of LLDB (the debugger) to start the omiserver process.

Now in a PowerShell prompt on Windows (opened after setting the WinRM client configurations):

Enter-PSSession -ComputerName <IP address of Linux machine> -Credential $cred -Authentication basic

The $cred variable can be empty; a credentials prompt will appear, enter any fake credentials you wish as authentication is not yet implemented.

The IP address of the Linux machine can be obtained with:

ip -f inet addr show dev eth0

Desired State Configuration

DSC support is in its infancy.

DSC also uses OMI, so build it first, then build DSC against it. Unfortunately, DSC cannot be configured to look for OMI elsewhere, so for now you need to symlink it to the expected location.

ln -s ../omi/Unix/ omi-1.0.8
./configure --no-rpm --no-dpkg --local
make -j

Detailed Build Script Notes

This explains ./build.sh.

The variable $BIN is the output directory, bin.

Managed

Builds with dotnet-cli. Publishes all dependencies into the bin directory. Emits its own native host as bin/powershell.

cd src/Microsoft.PowerShell.Linux.Host
dotnet publish --framework dnxcore50 --output $BIN
# Copy files that dotnet-publish doesn't currently deploy
cp *.ps1xml *_profile.ps1 $BIN

Native

  • libpsl-native.so: native functions that CorePsPlatform.cs P/Invokes
  • api-ms-win-core-registry-l1-1-0.dll: registry stub to prevent missing DLL error on shutdown

libpsl-native

Driven by CMake, with its own unit tests using Google Test.

cd src/libpsl-native
cmake -DCMAKE_BUILD_TYPE=Debug .
make -j
ctest -V
# Deploy development copy of libpsl-native
cp native/libpsl-native.* $BIN

The output is a .so on Linux and .dylib on OS X. It is unnecessary for Windows.

registry-stub

Provides RegCloseKey() to satisfy the disposal of SafeHandle objects on shutdown.

cd src/registry-stub
make
cp api-ms-win-core-registry-l1-1-0.dll $BIN