github.com/BarDweller/libpak@v0.0.0-20230630201634-8dd5cfc15ec9/sherpa/sherpa_test.go (about)

     1  /*
     2   * Copyright 2018-2020 the original author or authors.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *      https://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package sherpa_test
    18  
    19  import (
    20  	"bytes"
    21  	"fmt"
    22  	"testing"
    23  
    24  	mocks1 "github.com/buildpacks/libcnb/mocks"
    25  	. "github.com/onsi/gomega"
    26  	"github.com/sclevine/spec"
    27  	"github.com/stretchr/testify/mock"
    28  
    29  	"github.com/BarDweller/libpak/sherpa"
    30  	mocks2 "github.com/BarDweller/libpak/sherpa/mocks"
    31  )
    32  
    33  func testSherpa(t *testing.T, context spec.G, it spec.S) {
    34  	var (
    35  		Expect = NewWithT(t).Expect
    36  
    37  		exitHandler *mocks1.ExitHandler
    38  	)
    39  
    40  	it.Before(func() {
    41  		exitHandler = &mocks1.ExitHandler{}
    42  		exitHandler.On("Error", mock.Anything)
    43  	})
    44  
    45  	context("Execute", func() {
    46  
    47  		it("exits with error", func() {
    48  			sherpa.Execute(func() error {
    49  				return fmt.Errorf("test-error")
    50  			}, sherpa.WithExitHandler(exitHandler))
    51  
    52  			Expect(exitHandler.Calls).To(HaveLen(1))
    53  		})
    54  
    55  		it("exits without error", func() {
    56  			sherpa.Execute(func() error {
    57  				return nil
    58  			}, sherpa.WithExitHandler(exitHandler))
    59  
    60  			Expect(exitHandler.Calls).To(HaveLen(0))
    61  		})
    62  
    63  	})
    64  
    65  	context("Helpers", func() {
    66  
    67  		var (
    68  			execd *mocks2.ExecD
    69  		)
    70  
    71  		it.Before(func() {
    72  			execd = &mocks2.ExecD{}
    73  		})
    74  
    75  		it("returns error with no command name", func() {
    76  			err := sherpa.Helpers(map[string]sherpa.ExecD{}, sherpa.WithArguments([]string{}))
    77  
    78  			Expect(err).To(MatchError("expected command name"))
    79  		})
    80  
    81  		it("returns error with unsupported command name", func() {
    82  			err := sherpa.Helpers(map[string]sherpa.ExecD{}, sherpa.WithArguments([]string{"test"}))
    83  
    84  			Expect(err).To(MatchError("unsupported command test"))
    85  		})
    86  
    87  		it("returns error from helper", func() {
    88  			execd.On("Execute").Return(nil, fmt.Errorf("test-error"))
    89  
    90  			err := sherpa.Helpers(map[string]sherpa.ExecD{"test": execd}, sherpa.WithArguments([]string{"test"}))
    91  
    92  			Expect(err).To(MatchError("test-error"))
    93  		})
    94  
    95  		it("handles nil environment map", func() {
    96  			execd.On("Execute").Return(nil, nil)
    97  			b := &bytes.Buffer{}
    98  
    99  			err := sherpa.Helpers(map[string]sherpa.ExecD{"test": execd},
   100  				sherpa.WithArguments([]string{"test"}),
   101  				sherpa.WithExecdWriter(b),
   102  			)
   103  
   104  			Expect(err).NotTo(HaveOccurred())
   105  			Expect(b.String()).To(Equal(""))
   106  		})
   107  
   108  		it("writes output to fd/3", func() {
   109  			execd.On("Execute").Return(map[string]string{"TEST_KEY": "test-value"}, nil)
   110  			b := &bytes.Buffer{}
   111  
   112  			err := sherpa.Helpers(map[string]sherpa.ExecD{"test": execd},
   113  				sherpa.WithArguments([]string{"test"}),
   114  				sherpa.WithExecdWriter(b),
   115  			)
   116  
   117  			Expect(err).NotTo(HaveOccurred())
   118  			Expect(b.String()).To(Equal("TEST_KEY=\"test-value\"\n"))
   119  		})
   120  	})
   121  }