winrmtest

README

winrmtest

An in-progress testing package to compliment the masterzen/winrm Go-based winrm library.

My primary use-case for this is for dylanmei/packer-communicator-winrm, a Packer communicator plugin for interacting with machines using Windows Remote Management.

Example Use

A fictitious "Windows tools" package.

package wintools

import (
	"io"
	"testing"
	"github.com/dylanmei/winrmtest"
)

func Test_empty_temp_directory(t *testing.T) {
	r := winrmtest.NewRemote()
	defer r.Close()

	r.CommandFunc(wimrmtest.MatchText("dir C:\Temp"), func(out, err io.Writer) int {
		out.Write([]byte(` Volume in drive C is Windows 2012 R2
 Volume Serial Number is XXXX-XXXX

 Directory of C:\

File Not Found`))
		return 0
	})

	lister := NewDirectoryLister(r.Host, r.Port)
	list, _ := lister.TempDirectory()

	if count := len(list.Dirs()); count != 0 {
		t.Errorf("Expected 0 directories but found %d.\n", count)
	}

	if count := len(list.Files()); count != 0 {
		t.Errorf("Expected 0 files but found %d.\n", count)
	}
}

Documentation

Index

• type CommandFunc
• type MatcherFunc
  • func MatchPattern(pattern string) MatcherFunc
  • func MatchText(text string) MatcherFunc
• type Remote
  • func NewRemote() *Remote
  • func (r *Remote) Close()
  • func (r *Remote) CommandFunc(m MatcherFunc, f CommandFunc)

Types

type CommandFunc

type CommandFunc func(out, err io.Writer) (exitCode int)

CommandFunc respresents a function used to mock WinRM commands

type MatcherFunc

type MatcherFunc func(candidate string) bool

MatcherFunc respresents a function used to match WinRM commands

func MatchPattern

func MatchPattern(pattern string) MatcherFunc

MatchPattern return a new MatcherFunc based on pattern matching

func MatchText

func MatchText(text string) MatcherFunc

MatchText return a new MatcherFunc based on text matching

type Remote

type Remote struct {
	Host string
	Port int
	// contains filtered or unexported fields
}

Remote respresents a WinRM server

func NewRemote

func NewRemote() *Remote

NewRemote returns a new initialized Remote

func (*Remote) Close

func (r *Remote) Close()

Close closes the WinRM server

func (*Remote) CommandFunc

func (r *Remote) CommandFunc(m MatcherFunc, f CommandFunc)

CommandFunc adds a WinRM command mock function to the WinRM server