github.com/drone/runner-go@v1.12.0/pipeline/runtime/replacer_test.go (about)

     1  // Copyright 2019 Drone.IO Inc. All rights reserved.
     2  // Use of this source code is governed by the Polyform License
     3  // that can be found in the LICENSE file.
     4  
     5  package runtime
     6  
     7  import (
     8  	"bytes"
     9  	"io"
    10  	"testing"
    11  )
    12  
    13  func TestReplace(t *testing.T) {
    14  	secrets := []Secret{
    15  		&mockSecret{Name: "DOCKER_USERNAME", Data: "octocat", Mask: false},
    16  		&mockSecret{Name: "DOCKER_PASSWORD", Data: "correct-horse-batter-staple", Mask: true},
    17  		&mockSecret{Name: "DOCKER_EMAIL", Data: "", Mask: true},
    18  	}
    19  
    20  	buf := new(bytes.Buffer)
    21  	w := newReplacer(&nopCloser{buf}, secrets)
    22  	w.Write([]byte("username octocat password correct-horse-batter-staple"))
    23  	w.Close()
    24  
    25  	if got, want := buf.String(), "username octocat password ******"; got != want {
    26  		t.Errorf("Want masked string %s, got %s", want, got)
    27  	}
    28  }
    29  
    30  func TestReplaceMultiline(t *testing.T) {
    31  	key := `
    32  -----BEGIN PRIVATE KEY-----
    33  MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEA0SC5BIYpanOv6wSm
    34  dHVVMRa+6iw/0aJpT9/LKcZ0XYQ43P9Vwn8c46MDvFJ+Uy41FwbxT+QpXBoLlp8D
    35  sJY/dQIDAQABAkAesoL2GwtxSNIF2YTli2OZ9RDJJv2nNAPpaZxU4YCrST1AXGPB
    36  tFm0LjYDDlGJ448syKRpdypAyCR2LidwrVRxAiEA+YU5Zv7bOwODCsmtQtIfBfhu
    37  6SMBGMDijK7OYfTtjQsCIQDWjvly6b6doVMdNjqqTsnA8J1ShjSb8bFXkMels941
    38  fwIhAL4Rr7I3PMRtXmrfSa325U7k+Yd59KHofCpyFiAkNLgVAiB8JdR+wnOSQAOY
    39  loVRgC9LXa6aTp9oUGxeD58F6VK9PwIhAIDhSxkrIatXw+dxelt8DY0bEdDbYzky
    40  r9nicR5wDy2W
    41  -----END PRIVATE KEY-----`
    42  
    43  	line := `> MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEA0SC5BIYpanOv6wSm`
    44  
    45  	secrets := []Secret{
    46  		&mockSecret{Name: "SSH_KEY", Data: key, Mask: true},
    47  	}
    48  
    49  	buf := new(bytes.Buffer)
    50  	w := newReplacer(&nopCloser{buf}, secrets)
    51  	w.Write([]byte(line))
    52  	w.Close()
    53  
    54  	if got, want := buf.String(), "> ******"; got != want {
    55  		t.Errorf("Want masked string %s, got %s", want, got)
    56  	}
    57  }
    58  
    59  func TestReplaceMultilineJson(t *testing.T) {
    60  	key := `{
    61    "token":"MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEA0SC5BIYpanOv6wSm"
    62  }`
    63  
    64  	line := `{
    65    "token":"MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEA0SC5BIYpanOv6wSm"
    66  }`
    67  
    68  	secrets := []Secret{
    69  		&mockSecret{Name: "JSON_KEY", Data: key, Mask: true},
    70  	}
    71  
    72  	buf := new(bytes.Buffer)
    73  	w := newReplacer(&nopCloser{buf}, secrets)
    74  	w.Write([]byte(line))
    75  	w.Close()
    76  
    77  	if got, want := buf.String(), "{\n  ******\n}"; got != want {
    78  		t.Errorf("Want masked string %s, got %s", want, got)
    79  	}
    80  }
    81  
    82  // this test verifies that if there are no secrets to scan and
    83  // mask, the io.WriteCloser is returned as-is.
    84  func TestReplaceNone(t *testing.T) {
    85  	secrets := []Secret{
    86  		&mockSecret{Name: "DOCKER_USERNAME", Data: "octocat", Mask: false},
    87  		&mockSecret{Name: "DOCKER_PASSWORD", Data: "correct-horse-batter-staple", Mask: false},
    88  	}
    89  
    90  	buf := new(bytes.Buffer)
    91  	w := &nopCloser{buf}
    92  	r := newReplacer(w, secrets)
    93  	if w != r {
    94  		t.Errorf("Expect buffer returned with no replacer")
    95  	}
    96  }
    97  
    98  type nopCloser struct {
    99  	io.Writer
   100  }
   101  
   102  func (*nopCloser) Close() error {
   103  	return nil
   104  }
   105  
   106  type mockSecret struct {
   107  	Name string
   108  	Data string
   109  	Mask bool
   110  }
   111  
   112  func (s *mockSecret) GetName() string  { return s.Name }
   113  func (s *mockSecret) GetValue() string { return s.Data }
   114  func (s *mockSecret) IsMasked() bool   { return s.Mask }