chore(log): remove prefix out: and err: prefix (#287 )

- Simplify log output by removing "out:" and "err:" prefixes in `plugin.go` - Update test expectations to match the new log output format Signed-off-by: appleboy <appleboy.tw@gmail.com>
fix: improve script file handling and testing robustness
2026-06-16 14:49:25 +08:00 · 2024-11-17 14:48:14 +08:00 · 2024-11-17 14:32:06 +08:00 · 2024-11-17 14:18:47 +08:00 · 2024-11-16 10:05:31 +08:00 · 2024-11-16 09:58:21 +08:00
13 changed files with 286 additions and 223 deletions
@@ -38,11 +38,11 @@ jobs:

    steps:
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4

      # Initializes the CodeQL tools for scanning.
      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
        with:
          languages: ${{ matrix.language }}
          # If you wish to specify custom queries, you can do so here or in a config file.
@@ -51,4 +51,4 @@ jobs:
          # queries: ./path/to/local/query, your-org/your-repo/queries@main

      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
@@ -14,35 +14,34 @@ jobs:
  build-docker:
    runs-on: ubuntu-latest
    steps:
-      - name: Setup go
-        uses: actions/setup-go@v4
-        with:
-          go-version: "^1.21"
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Setup go
+        uses: actions/setup-go@v5
        with:
-          fetch-depth: 0
+          go-version-file: go.mod
+          check-latest: true

      - name: Build binary
        run: |
          make build_linux_amd64
-          make build_linux_arm
          make build_linux_arm64

      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3

      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3

      - name: Login to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Login to GitHub Container Registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
@@ -50,7 +49,7 @@ jobs:

      - name: Docker meta
        id: docker-meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
        with:
          images: |
            ${{ github.repository }}
@@ -62,11 +61,13 @@ jobs:
            type=semver,pattern={{major}}

      - name: Build and push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
        with:
          context: .
-          platforms: linux/amd64,linux/arm,linux/arm64
+          platforms: linux/amd64,linux/arm64
          file: docker/Dockerfile
          push: ${{ github.event_name != 'pull_request' }}
          tags: ${{ steps.docker-meta.outputs.tags }}
          labels: ${{ steps.docker-meta.outputs.labels }}
+          cache-from: type=registry,ref=ghcr.io/${{ github.repository }}:buildcache
+          cache-to: type=registry,ref=ghcr.io/${{ github.repository }}:buildcache,mode=max
@@ -12,21 +12,23 @@ jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v4
        with:
          fetch-depth: 0
+
      - name: Setup go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
        with:
-          go-version: "^1"
+          go-version-file: go.mod
+          check-latest: true

      - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v4
+        uses: goreleaser/goreleaser-action@v6
        with:
          # either 'goreleaser' (default) or 'goreleaser-pro'
          distribution: goreleaser
          version: latest
-          args: release --rm-dist
+          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -8,14 +8,17 @@ jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
-      - name: Setup go
-        uses: actions/setup-go@v4
-        with:
-          go-version: "^1.21"
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Setup go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+          check-latest: true
+
      - name: Setup golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v6
        with:
          version: latest
          args: --verbose
@@ -27,10 +30,12 @@ jobs:

  testing:
    runs-on: ubuntu-latest
-    container: golang:1.21-alpine
+    container:
+      image: golang:1.22-alpine
+      options: --sysctl net.ipv6.conf.all.disable_ipv6=0
    steps:
      - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4

      - name: setup sshd server
        run: |
@@ -42,4 +47,4 @@ jobs:
          make test

      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
@@ -0,0 +1,42 @@
+run:
+  timeout: 5m
+linters:
+  enable:
+    - asciicheck
+    - durationcheck
+    - errcheck
+    - errorlint
+    - exportloopref
+    - gci
+    - gofmt
+    - goimports
+    - gosec
+    - misspell
+    - nakedret
+    - nilerr
+    - nolintlint
+    - perfsprint
+    - revive
+    - usestdlibvars
+    - wastedassign
+
+linters-settings:
+  gosec:
+    # To select a subset of rules to run.
+    # Available rules: https://github.com/securego/gosec#available-rules
+    # Default: [] - means include all rules
+    includes:
+      - G102
+      - G106
+      - G108
+      - G109
+      - G111
+      - G112
+      - G201
+      - G203
+  perfsprint:
+    err-error: true
+    errorf: true
+    int-conversion: true
+    sprintf1: true
+    strconcat: true
@@ -3,78 +3,78 @@ before:
    - go mod tidy

 builds:
- env:
-  - CGO_ENABLED=0
-  goos:
-  - darwin
-  - linux
-  - windows
-  - freebsd
-  goarch:
-  - amd64
-  - arm
-  - arm64
-  goarm:
-  - "5"
-  - "6"
-  - "7"
-  ignore:
-    - goos: darwin
-      goarch: arm
-    - goos: darwin
-      goarch: ppc64le
-    - goos: darwin
-      goarch: s390x
-    - goos: windows
-      goarch: ppc64le
-    - goos: windows
-      goarch: s390x
-    - goos: windows
-      goarch: arm
-      goarm: "5"
-    - goos: windows
-      goarch: arm
-      goarm: "6"
-    - goos: windows
-      goarch: arm
-      goarm: "7"
-    - goos: windows
-      goarch: arm64
-    - goos: freebsd
-      goarch: ppc64le
-    - goos: freebsd
-      goarch: s390x
-    - goos: freebsd
-      goarch: arm
-      goarm: "5"
-    - goos: freebsd
-      goarch: arm
-      goarm: "6"
-    - goos: freebsd
-      goarch: arm
-      goarm: "7"
-    - goos: freebsd
-      goarch: arm64
-  flags:
-  - -trimpath
-  ldflags:
-  - -s -w
-  - -X main.Version={{.Version}}
-  binary: >-
-    {{ .ProjectName }}-
-    {{- if .IsSnapshot }}{{ .Branch }}-
-    {{- else }}{{- .Version }}-{{ end }}
-    {{- .Os }}-
-    {{- if eq .Arch "amd64" }}amd64
-    {{- else if eq .Arch "amd64_v1" }}amd64
-    {{- else if eq .Arch "386" }}386
-    {{- else }}{{ .Arch }}{{ end }}
-    {{- if .Arm }}-{{ .Arm }}{{ end }}
-  no_unique_dist_dir: true
-  hooks:
-    post:
-      - cmd: xz -k -9 {{ .Path }}
-        dir: ./dist/
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - darwin
+      - linux
+      - windows
+      - freebsd
+    goarch:
+      - amd64
+      - arm
+      - arm64
+    goarm:
+      - "5"
+      - "6"
+      - "7"
+    ignore:
+      - goos: darwin
+        goarch: arm
+      - goos: darwin
+        goarch: ppc64le
+      - goos: darwin
+        goarch: s390x
+      - goos: windows
+        goarch: ppc64le
+      - goos: windows
+        goarch: s390x
+      - goos: windows
+        goarch: arm
+        goarm: "5"
+      - goos: windows
+        goarch: arm
+        goarm: "6"
+      - goos: windows
+        goarch: arm
+        goarm: "7"
+      - goos: windows
+        goarch: arm64
+      - goos: freebsd
+        goarch: ppc64le
+      - goos: freebsd
+        goarch: s390x
+      - goos: freebsd
+        goarch: arm
+        goarm: "5"
+      - goos: freebsd
+        goarch: arm
+        goarm: "6"
+      - goos: freebsd
+        goarch: arm
+        goarm: "7"
+      - goos: freebsd
+        goarch: arm64
+    flags:
+      - -trimpath
+    ldflags:
+      - -s -w
+      - -X main.Version={{.Version}}
+    binary: >-
+      {{ .ProjectName }}-
+      {{- if .IsSnapshot }}{{ .Branch }}-
+      {{- else }}{{- .Version }}-{{ end }}
+      {{- .Os }}-
+      {{- if eq .Arch "amd64" }}amd64
+      {{- else if eq .Arch "amd64_v1" }}amd64
+      {{- else if eq .Arch "386" }}386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}-{{ .Arm }}{{ end }}
+    no_unique_dist_dir: true
+    hooks:
+      post:
+        - cmd: xz -k -9 {{ .Path }}
+          dir: ./dist/

 archives:
  - format: binary
@@ -82,9 +82,9 @@ archives:
    allow_different_binary_count: true

 checksum:
-  name_template: 'checksums.txt'
+  name_template: "checksums.txt"
  extra_files:
-      - glob: ./**.xz
+    - glob: ./**.xz

 snapshot:
  name_template: "{{ incpatch .Version }}"
@@ -97,3 +97,27 @@ release:
  # Templates: allowed
  extra_files:
    - glob: ./**.xz
+
+changelog:
+  use: github
+  groups:
+    - title: Features
+      regexp: "^.*feat[(\\w)]*:+.*$"
+      order: 0
+    - title: "Bug fixes"
+      regexp: "^.*fix[(\\w)]*:+.*$"
+      order: 1
+    - title: "Enhancements"
+      regexp: "^.*chore[(\\w)]*:+.*$"
+      order: 2
+    - title: "Refactor"
+      regexp: "^.*refactor[(\\w)]*:+.*$"
+      order: 3
+    - title: "Build process updates"
+      regexp: ^.*?(build|ci)(\(.+\))??!?:.+$
+      order: 4
+    - title: "Documentation updates"
+      regexp: ^.*?docs?(\(.+\))??!?:.+$
+      order: 4
+    - title: Others
+      order: 999
@@ -4,7 +4,7 @@

 [![GitHub tag](https://img.shields.io/github/tag/appleboy/drone-ssh.svg)](https://github.com/appleboy/drone-ssh/releases)
 [![GoDoc](https://godoc.org/github.com/appleboy/drone-ssh?status.svg)](https://godoc.org/github.com/appleboy/drone-ssh)
-[![Lint and Testing](https://github.com/appleboy/drone-ssh/actions/workflows/lint.yml/badge.svg)](https://github.com/appleboy/drone-ssh/actions/workflows/lint.yml)
+[![Lint and Testing](https://github.com/appleboy/drone-ssh/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/appleboy/drone-ssh/actions/workflows/testing.yml)
 [![codecov](https://codecov.io/gh/appleboy/drone-ssh/branch/master/graph/badge.svg)](https://codecov.io/gh/appleboy/drone-ssh)
 [![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/drone-ssh)](https://goreportcard.com/report/github.com/appleboy/drone-ssh)
 [![Docker Pulls](https://img.shields.io/docker/pulls/appleboy/drone-ssh.svg)](https://hub.docker.com/r/appleboy/drone-ssh/)
@@ -1,4 +1,4 @@
-FROM alpine:3.17
+FROM alpine:3.20

 ARG TARGETOS
 ARG TARGETARCH
@@ -12,7 +12,7 @@ LABEL org.opencontainers.image.source=https://github.com/appleboy/drone-ssh
 LABEL org.opencontainers.image.description="Execute commands on a remote host through SSH"
 LABEL org.opencontainers.image.licenses=MIT

-RUN apk add --no-cache ca-certificates && \
+RUN apk add --no-cache ca-certificates tzdata && \
  rm -rf /var/cache/apk/*

 RUN addgroup \
@@ -1,23 +1,23 @@
 module github.com/appleboy/drone-ssh

-go 1.18
+go 1.22

 require (
 	github.com/appleboy/easyssh-proxy v1.5.0
 	github.com/joho/godotenv v1.5.1
 	github.com/stretchr/testify v1.8.4
-	github.com/urfave/cli/v2 v2.27.1
-	golang.org/x/crypto v0.18.0
+	github.com/urfave/cli/v2 v2.27.5
+	golang.org/x/crypto v0.29.0
 )

 require (
 	github.com/ScaleFT/sshkeys v1.2.0 // indirect
-	github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.5 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dchest/bcrypt_pbkdf v0.0.0-20150205184540-83f37f9c154a // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/xrash/smetrics v0.0.0-20231213231151-1d8dd44e695e // indirect
-	golang.org/x/sys v0.16.0 // indirect
+	github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
+	golang.org/x/sys v0.27.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
@@ -2,8 +2,8 @@ github.com/ScaleFT/sshkeys v1.2.0 h1:5BRp6rTVIhJzXT3VcUQrKgXR8zWA3sOsNeuyW15WUA8
 github.com/ScaleFT/sshkeys v1.2.0/go.mod h1:gxOHeajFfvGQh/fxlC8oOKBe23xnnJTif00IFFbiT+o=
 github.com/appleboy/easyssh-proxy v1.5.0 h1:OYdSPvYQN3mhnsMH5I2OF1TgwSEcSq33kvjQfTwvZww=
 github.com/appleboy/easyssh-proxy v1.5.0/go.mod h1:zcEMrStH91/tcUn3gUGP0KpQwUYLm8tX/Ook1AH98uc=
-github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0qnXZOBM=
-github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/cpuguy83/go-md2man/v2 v2.0.5 h1:ZtcqGrnekaHpVLArFSe4HK5DoKx1T0rq2DwVB0alcyc=
+github.com/cpuguy83/go-md2man/v2 v2.0.5/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -19,21 +19,22 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/urfave/cli/v2 v2.27.1 h1:8xSQ6szndafKVRmfyeUMxkNUJQMjL1F2zmsZ+qHpfho=
-github.com/urfave/cli/v2 v2.27.1/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
-github.com/xrash/smetrics v0.0.0-20231213231151-1d8dd44e695e h1:+SOyEddqYF09QP7vr7CgJ1eti3pY9Fn3LHO1M1r/0sI=
-github.com/xrash/smetrics v0.0.0-20231213231151-1d8dd44e695e/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
+github.com/urfave/cli/v2 v2.27.5 h1:WoHEJLdsXr6dDWoJgMq/CboDmyY/8HMMH1fTECbih+w=
+github.com/urfave/cli/v2 v2.27.5/go.mod h1:3Sevf16NykTbInEnD0yKkjDAeZDS0A6bzhBH5hrMvTQ=
+github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
+github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
-golang.org/x/crypto v0.18.0 h1:PGVlW0xEltQnzFZ55hkuX5+KLyrMYhHld1YHO4AKcdc=
-golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg=
+golang.org/x/crypto v0.29.0 h1:L5SG1JTTXupVV3n6sUqMTeWbjAyfPwoda2DLX8J8FrQ=
+golang.org/x/crypto v0.29.0/go.mod h1:+F4F4N5hv6v38hfeYwTdx20oUvLLc+QfrE9Ax9HtgRg=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200219091948-cb0a6d8edb6c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
-golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/term v0.16.0 h1:m+B6fahuftsE9qjo0VWp2FW0mB3MTJvR0BaMQrq0pmE=
+golang.org/x/sys v0.27.0 h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=
+golang.org/x/sys v0.27.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.26.0 h1:WEQa6V3Gja/BhNxg540hBip/kkaYtRg3cxg4oXSw4AU=
+golang.org/x/term v0.26.0/go.mod h1:Si5m1o57C5nBNQo5z1iq+XDijt21BDBDp2bK0QI8e3E=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
@@ -6,7 +6,7 @@ import (
 	"strconv"
 	"time"

-	"github.com/appleboy/easyssh-proxy"
+	easyssh "github.com/appleboy/easyssh-proxy"
 	"github.com/joho/godotenv"
 	"github.com/urfave/cli/v2"
 )
@@ -38,10 +38,11 @@ func main() {
 	app.Version = Version
 	app.Flags = []cli.Flag{
 		&cli.StringSliceFlag{
-			Name:    "host",
-			Aliases: []string{"H"},
-			Usage:   "connect to host",
-			EnvVars: []string{"PLUGIN_HOST", "SSH_HOST", "INPUT_HOST"},
+			Name:     "host",
+			Aliases:  []string{"H"},
+			Usage:    "connect to host",
+			EnvVars:  []string{"PLUGIN_HOST", "SSH_HOST", "INPUT_HOST"},
+			FilePath: ".host",
 		},
 		&cli.IntFlag{
 			Name:    "port",
@@ -130,6 +131,11 @@ func main() {
 			Usage:   "execute single commands for github action",
 			EnvVars: []string{"INPUT_SCRIPT"},
 		},
+		&cli.StringFlag{
+			Name:    "script.file",
+			Usage:   "execute commands from a file for github action",
+			EnvVars: []string{"PLUGIN_SCRIPT_FILE", "INPUT_SCRIPT_FILE"},
+		},
 		&cli.BoolFlag{
 			Name:    "script.stop",
 			Usage:   "stop script after first failure",
@@ -270,6 +276,18 @@ func run(c *cli.Context) error {
 		scripts = append(scripts, s)
 	}

+	if f := c.String("script.file"); f != "" {
+		// check file exists
+		if _, err := os.Stat(f); err != nil {
+			return err
+		}
+		s, err := os.ReadFile(f)
+		if err != nil {
+			return err
+		}
+		scripts = append(scripts, string(s))
+	}
+
 	plugin := Plugin{
 		Config: Config{
 			Key:               c.String("ssh-key"),
@@ -10,7 +10,7 @@ import (
 	"sync"
 	"time"

-	"github.com/appleboy/easyssh-proxy"
+	easyssh "github.com/appleboy/easyssh-proxy"
 )

 var (
@@ -105,9 +105,11 @@ func (p Plugin) exec(host string, wg *sync.WaitGroup, errChannel chan error) {
 		},
 	}

-	p.log(host, "======CMD======")
-	p.log(host, strings.Join(p.Config.Script, "\n"))
-	p.log(host, "======END======")
+	if p.Config.Debug {
+		p.log(host, "======CMD======")
+		p.log(host, strings.Join(p.Config.Script, "\n"))
+		p.log(host, "======END======")
+	}

 	env := []string{}
 	if p.Config.AllEnvs {
@@ -123,7 +125,7 @@ func (p Plugin) exec(host string, wg *sync.WaitGroup, errChannel chan error) {

 	p.Config.Script = append(env, p.scriptCommands()...)

-	if p.Config.Debug {
+	if p.Config.Debug && len(env) > 0 {
 		p.log(host, "======ENV======")
 		p.log(host, strings.Join(env, "\n"))
 		p.log(host, "======END======")
@@ -135,7 +137,7 @@ func (p Plugin) exec(host string, wg *sync.WaitGroup, errChannel chan error) {
 		return
 	}
 	// read from the output channel until the done signal is passed
-	isTimeout := true
+	var isTimeout bool
 loop:
 	for {
 		select {
@@ -143,11 +145,11 @@ loop:
 			break loop
 		case outline := <-stdoutChan:
 			if outline != "" {
-				p.log(host, "out:", outline)
+				p.log(host, outline)
 			}
 		case errline := <-stderrChan:
 			if errline != "" {
-				p.log(host, "err:", errline)
+				p.log(host, errline)
 			}
 		case err = <-errChan:
 		}
@@ -228,9 +230,9 @@ func (p Plugin) Exec() error {
 		}
 	}

-	fmt.Println("==============================================")
-	fmt.Println("✅ Successfully executed commands to all host.")
-	fmt.Println("==============================================")
+	fmt.Println("===============================================")
+	fmt.Println("✅ Successfully executed commands to all hosts.")
+	fmt.Println("===============================================")

 	return nil
 }
@@ -365,17 +365,17 @@ func TestCommandOutput(t *testing.T) {
 			whoami
 			uname
 			localhost: ======END======
-			localhost: out: /home/drone-scp
-			localhost: out: drone-scp
-			localhost: out: Linux
+			localhost: /home/drone-scp
+			localhost: drone-scp
+			localhost: Linux
 			127.0.0.1: ======CMD======
 			127.0.0.1: pwd
 			whoami
 			uname
 			127.0.0.1: ======END======
-			127.0.0.1: out: /home/drone-scp
-			127.0.0.1: out: drone-scp
-			127.0.0.1: out: Linux
+			127.0.0.1: /home/drone-scp
+			127.0.0.1: drone-scp
+			127.0.0.1: Linux
 		`
 	)

@@ -392,6 +392,7 @@ func TestCommandOutput(t *testing.T) {
 			},
 			CommandTimeout: 60 * time.Second,
 			Sync:           true,
+			Debug:          true,
 		},
 		Writer: &buffer,
 	}
@@ -432,7 +433,6 @@ func getHostPublicKeyFile(keypath string) (ssh.PublicKey, error) {
 	}

 	pubkey, _, _, _, err = ssh.ParseAuthorizedKey(buf)
-
 	if err != nil {
 		return nil, err
 	}
@@ -444,10 +444,7 @@ func TestFingerprint(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-			======CMD======
-			whoami
-			======END======
-			out: drone-scp
+			drone-scp
 		`
 	)

@@ -478,11 +475,7 @@ func TestScriptStopWithMultipleHostAndSyncMode(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-			======CMD======
-			mkdir a/b/c
-			mkdir d/e/f
-			======END======
-			err: mkdir: can't create directory 'a/b/c': No such file or directory
+			mkdir: can't create directory 'a/b/c': No such file or directory
 		`
 	)

@@ -513,11 +506,7 @@ func TestScriptStop(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-			======CMD======
-			mkdir a/b/c
-			mkdir d/e/f
-			======END======
-			err: mkdir: can't create directory 'a/b/c': No such file or directory
+			mkdir: can't create directory 'a/b/c': No such file or directory
 		`
 	)

@@ -547,12 +536,8 @@ func TestNoneScriptStop(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-			======CMD======
-			mkdir a/b/c
-			mkdir d/e/f
-			======END======
-			err: mkdir: can't create directory 'a/b/c': No such file or directory
-			err: mkdir: can't create directory 'd/e/f': No such file or directory
+			mkdir: can't create directory 'a/b/c': No such file or directory
+			mkdir: can't create directory 'd/e/f': No such file or directory
 		`
 	)

@@ -599,13 +584,13 @@ func TestEnvOutput(t *testing.T) {
 			export ENV_6='test"'
 			export ENV_7='test,!#;?.@$~'\''"'
 			======END======
-			out: [test]
-			out: [test test]
-			out: [test ]
-			out: [  test  test  ]
-			out: [test']
-			out: [test"]
-			out: [test,!#;?.@$~'"]
+			[test]
+			[test test]
+			[test ]
+			[  test  test  ]
+			[test']
+			[test"]
+			[test,!#;?.@$~'"]
 		`
 	)

@@ -734,12 +719,8 @@ func TestUseInsecureCipher(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-			======CMD======
-			mkdir a/b/c
-			mkdir d/e/f
-			======END======
-			err: mkdir: can't create directory 'a/b/c': No such file or directory
-			err: mkdir: can't create directory 'd/e/f': No such file or directory
+			mkdir: can't create directory 'a/b/c': No such file or directory
+			mkdir: can't create directory 'd/e/f': No such file or directory
 		`
 	)

@@ -890,14 +871,9 @@ func TestAllEnvs(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-======CMD======
-echo "[${INPUT_1}]"
-echo "[${GITHUB_2}]"
-echo "[${PLUGIN_3}]"
-======END======
-out: [foobar]
-out: [foobar]
-out: [foobar]
+[foobar]
+[foobar]
+[foobar]
 		`
 	)

@@ -939,10 +915,7 @@ func TestSudoCommand(t *testing.T) {
 	var (
 		buffer   bytes.Buffer
 		expected = `
-			======CMD======
-			sudo su - -c "whoami"
-			======END======
-			out: root
+			root
 		`
 	)

@@ -965,33 +938,28 @@ func TestSudoCommand(t *testing.T) {
 	assert.Equal(t, unindent(expected), unindent(buffer.String()))
 }

-// TODO: TestCommandWithIPv6 is not working on github actions.
-// func TestCommandWithIPv6(t *testing.T) {
-// 	var (
-// 		buffer   bytes.Buffer
-// 		expected = `
-// 			======CMD======
-// 			whoami
-// 			======END======
-// 			out: drone-scp
-// 		`
-// 	)
+func TestCommandWithIPv6(t *testing.T) {
+	var (
+		buffer   bytes.Buffer
+		expected = `
+			drone-scp
+		`
+	)

-// 	plugin := Plugin{
-// 		Config: Config{
-// 			Host:     []string{"::1"},
-// 			Username: "drone-scp",
-// 			Port:     22,
-// 			KeyPath:  "./tests/.ssh/id_rsa",
-// 			Script: []string{
-// 				"whoami",
-// 			},
-// 			Protocol:       easyssh.PROTOCOL_TCP6,
-// 			CommandTimeout: 10 * time.Second,
-// 		},
-// 		Writer: &buffer,
-// 	}
-
-// 	assert.Nil(t, plugin.Exec())
-// 	assert.Equal(t, unindent(expected), unindent(buffer.String()))
-// }
+	plugin := Plugin{
+		Config: Config{
+			Host:     []string{"::1"},
+			Username: "drone-scp",
+			Port:     22,
+			KeyPath:  "./tests/.ssh/id_rsa",
+			Script: []string{
+				"whoami",
+			},
+			Protocol:       easyssh.PROTOCOL_TCP6,
+			CommandTimeout: 10 * time.Second,
+		},
+		Writer: &buffer,
+	}
+	assert.Nil(t, plugin.Exec())
+	assert.Equal(t, unindent(expected), unindent(buffer.String()))
+}
Author	SHA1	Message	Date
Bo-Yi Wu	883f947b4f	chore(log): remove prefix out: and err: prefix (#287 ) - Simplify log output by removing "out:" and "err:" prefixes in `plugin.go` - Update test expectations to match the new log output format Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-11-17 14:48:14 +08:00
appleboy	2c52afb7fd	fix: improve script file handling and testing robustness - Add a check to verify if the script file exists before reading it Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-11-17 14:32:06 +08:00
appleboy	d56db7a5b3	chore(deps): update dependencies to latest versions - Update `github.com/urfave/cli/v2` to version `2.27.5` - Update `golang.org/x/crypto` to version `0.29.0` - Update `github.com/cpuguy83/go-md2man/v2` to version `2.0.5` - Update `golang.org/x/sys` to version `0.27.0` Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-11-17 14:18:47 +08:00
appleboy	67cd964f13	ci(github): improve CI workflows and API integration - Add `fetch-depth: 0` to the `actions/checkout` step in the `goreleaser` GitHub workflow Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-11-16 10:05:31 +08:00
appleboy	2519a9a894	ci(golangci): enable comprehensive linting and update variable initialization - Add a `.golangci.yaml` configuration file with various linters enabled and specific settings for `gosec` and `perfsprint`. - Change `isTimeout` from being initialized to `true` to being declared as a `bool` variable without an initial value in `plugin.go`. Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-11-16 09:58:21 +08:00
appleboy	1edb4744ca	feat(envs): support drone plugin - Add `PLUGIN_SCRIPT_FILE` to the environment variables list in the main function Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-10-27 22:22:23 +08:00
Kyle Leonhard	43270d582c	chore: add support for passing commands via a file (#285 )	2024-10-24 09:56:07 +08:00
Lukáš Tesař	dc927a6123	fix: typo in success message (#283 ) My OCD just kicks in :)) This has bothered me for a long time. Will also update README in https://github.com/appleboy/ssh-action to reflect this change.	2024-10-13 09:00:20 +08:00
Bo-Yi Wu	ceb4e12d92	chore: update base image to Alpine 3.20 - Update base image from alpine version 3.17 to 3.20 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-09-07 15:15:40 +08:00
Bo-Yi Wu	2041794fd5	ci: update Go version and enhance GitHub Actions workflow - Update Go version in GitHub Actions workflow from 1.21 to 1.22 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-07-14 15:42:01 +08:00
Bo-Yi Wu	a2d37cbc1d	chore: update dependencies and improve test coverage - Update Go version from 1.18 to 1.22 in go.mod Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-07-14 15:35:48 +08:00
Bo-Yi Wu	aa872a30be	style: refactor import aliases for easyssh library - Alias `github.com/appleboy/easyssh-proxy` import as `easyssh` in `main.go` - Alias `github.com/appleboy/easyssh-proxy` import as `easyssh` in `plugin.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-07-14 15:30:53 +08:00
Bo-Yi Wu	c049944302	chore: update Go dependencies to latest versions - Update `golang.org/x/crypto` dependency from `v0.24.0` to `v0.25.0` - Update `golang.org/x/sys` dependency from `v0.21.0` to `v0.22.0` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-07-14 15:25:54 +08:00
Bo-Yi Wu	0914cd212b	test: enable comprehensive debugging in plugin execution (#278 ) * test: enable comprehensive debugging in plugin execution - Add debug logging to `exec` function in `plugin.go` - Enable debug mode in `TestCommandOutput` and `TestSudoCommand` tests - Remove redundant command blocks from multiple tests in `plugin_test.go` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * test: refactor codebase to improve performance and readability - Remove debug command block from `TestSudoCommand` test Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * refactor: refactor test environment setup and command markers - Add environment markers to `TestCommandOutput` for localhost and 127.0.0.1 - Remove command markers from `TestFingerprint` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> * fix: improve environment variable handling in debug mode - Add a check for non-empty environment variables when debug mode is enabled - Remove redundant environment variable output in tests Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com> --------- Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-07-14 15:24:36 +08:00
Bo-Yi Wu	e28acf4f3b	ci: update Docker actions and remove ARM build step - Remove `make build_linux_arm` step - Update `docker/setup-qemu-action` from v2 to v3 - Update `docker/setup-buildx-action` from v2 to v3 - Update `docker/login-action` from v2 to v3 - Update `docker/metadata-action` from v4 to v5 - Update `docker/build-push-action` from v4 to v6 - Remove `linux/arm` from the platforms list Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-07-14 14:23:53 +08:00
Bo-Yi Wu	c0e111cbef	ci: update GoReleaser action to version 6 - Update GoReleaser action from version 5 to version 6 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-06-12 15:06:46 +08:00
Bo-Yi Wu	50e34882a3	chore: update Go dependencies to latest versions - Update `golang.org/x/crypto` dependency from v0.23.0 to v0.24.0 - Update `golang.org/x/sys` dependency from v0.20.0 to v0.21.0 Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-06-05 13:31:31 +08:00
appleboy	31607874dc	chore: update dependencies to latest versions - Update `github.com/urfave/cli/v2` to version `2.27.2` - Update `golang.org/x/crypto` to version `0.23.0` - Update `github.com/xrash/smetrics` to version `0.0.0-20240521201337-686a1a2994c1` - Update `golang.org/x/sys` to version `0.20.0` Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-06-01 10:08:07 +08:00
appleboy	591c6c9f77	ci: update GitHub workflows and improve test configurations - Update golangci-lint-action from v4 to v6 in GitHub workflow Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-06-01 09:54:06 +08:00
appleboy	be0b134f0a	ci: optimize CI/CD pipeline with Docker build cache - Add Docker build cache configuration to GitHub Actions workflow Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-06-01 09:53:09 +08:00
Bo-Yi Wu	dc026ac547	feat: refactor configuration handling in main function (#275 ) - Add `FilePath` attribute with value `.host` to the configuration in `main` function Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-06-01 09:50:16 +08:00
Bo-Yi Wu	2e8030ff52	build: improve system compatibility and performance (#274 ) - Add `tzdata` package to the Dockerfile Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-06-01 09:29:39 +08:00
Bo-Yi Wu	5401378058	chore: refine Changelog Generation Process - Change the changelog generation from using git to using GitHub - Add custom changelog sections for build process and documentation updates with specific regex patterns and order Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-19 10:27:48 +08:00
Bo-Yi Wu	046c21368d	chore: update dependencies to latest versions - Update `golang.org/x/crypto` from `v0.18.0` to `v0.22.0` - Update `github.com/cpuguy83/go-md2man/v2` from `v2.0.3` to `v2.0.4` - Update `github.com/xrash/smetrics` to a newer commit - Update `golang.org/x/sys` from `v0.16.0` to `v0.19.0` Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-18 08:22:08 +08:00
Bo-Yi Wu	e8a39a16a6	chore: refactor release process configuration - Change the changelog configuration in `.goreleaser.yaml` from using GitHub to using git. Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-02 15:58:52 +08:00
Bo-Yi Wu	f8b1db2997	chore: refine goreleaser configuration and output - Change the name template in `.goreleaser.yaml` from single to double quotes - Add a changelog configuration to `.goreleaser.yaml` with categorized groups for features, bug fixes, enhancements, refactor, and others Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-02 14:57:44 +08:00
Bo-Yi Wu	f37c5b3557	ci: refactor CI workflows and update actions - Update GitHub Actions to use newer versions (checkout to v4, codeql-action to v3, setup-go to v5, goreleaser-action to v5, golangci-lint-action to v4, codecov-action to v4) - Remove specific Go version pinning in favor of using the version specified in go.mod - Enable checking for the latest Go version in setup-go action - Replace `release --rm-dist` argument with `release --clean` in goreleaser action - Reorder steps and remove redundant checkout step in testing workflow Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>	2024-04-02 14:10:03 +08:00
appleboy	2c5e17dd2e	docs: update badge Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-03-16 13:00:11 +08:00
appleboy	42f9adb1b5	test: rename the workflow	2024-03-16 12:58:52 +08:00
Bo-Yi Wu	cafc139713	test: enhance testing and internal API robustness (#269 ) * test: support ipv6 * chore: update Signed-off-by: appleboy <appleboy.tw@gmail.com> * chore: update Signed-off-by: appleboy <appleboy.tw@gmail.com> --------- Signed-off-by: appleboy <appleboy.tw@gmail.com>	2024-03-16 11:29:44 +08:00