sh/interp/handler_test.go at master · gitclone-url/sh · GitHub

History

401 lines (376 loc) · 9.52 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

// See LICENSE for licensing information

package interp_test

import (

"bufio"

"bytes"

"context"

"fmt"

"io"

"os"

"runtime"

"strconv"

"strings"

"sync"

"syscall"

"testing"

"time"

"mvdan.cc/sh/v3/interp"

"mvdan.cc/sh/v3/syntax"

)

func blocklistOneExec(name string) func(interp.ExecHandlerFunc) interp.ExecHandlerFunc {

return func(next interp.ExecHandlerFunc) interp.ExecHandlerFunc {

return func(ctx context.Context, args []string) error {

if args[0] == name {

return fmt.Errorf("%s: blocklisted program", name)

}

return next(ctx, args)

}

func blocklistAllExec(next interp.ExecHandlerFunc) interp.ExecHandlerFunc {

return func(ctx context.Context, args []string) error {

return fmt.Errorf("blocklisted: %s", args[0])

}

func blocklistNondevOpen(ctx context.Context, path string, flags int, mode os.FileMode) (io.ReadWriteCloser, error) {

if path != "/dev/null" {

return nil, fmt.Errorf("non-dev: %s", path)

}

return testOpenHandler(ctx, path, flags, mode)

}

func blocklistGlob(ctx context.Context, path string) ([]os.FileInfo, error) {

return nil, fmt.Errorf("blocklisted: glob")

}

func execPrint(next interp.ExecHandlerFunc) interp.ExecHandlerFunc {

return func(ctx context.Context, args []string) error {

hc := interp.HandlerCtx(ctx)

fmt.Fprintf(hc.Stdout, "would run: %s", args)

return nil

}

// runnerCtx allows us to give handler functions access to the Runner, if needed.

var runnerCtx = new(int)

func execPrintWouldExec(next interp.ExecHandlerFunc) interp.ExecHandlerFunc {

return func(ctx context.Context, args []string) error {

runner, ok := ctx.Value(runnerCtx).(*interp.Runner)

if ok && runner.Exited() {

return fmt.Errorf("would exec via builtin: %s", args)

}

return nil

}

// TODO: join with TestRunnerOpts?

var modCases = []struct {

name string

opts []interp.RunnerOption

src string

want string

}{

{

opts: []interp.RunnerOption{

interp.ExecHandlers(blocklistOneExec("sleep")),

src: "echo foo; sleep 1",

want: "foo\nsleep: blocklisted program",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(blocklistOneExec("faa")),

src: "a=$(echo foo | sed 's/o/a/g'); echo $a; $a args",

want: "faa\nfaa: blocklisted program",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(blocklistAllExec),

src: "(malicious)",

want: "blocklisted: malicious",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(blocklistAllExec),

src: "malicious | echo foo",

want: "foo\nblocklisted: malicious",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(blocklistAllExec),

src: "a=$(malicious)",

want: "blocklisted: malicious\n", // TODO: why the newline?

{

opts: []interp.RunnerOption{

interp.ExecHandlers(blocklistAllExec),

src: "{ malicious; true; } & { malicious; true; } & wait",

want: "blocklisted: malicious",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(execPrintWouldExec),

src: "exec /bin/sh",

want: "would exec via builtin: [/bin/sh]",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(

execPrint,

blocklistOneExec("foo"),

src: "foo",

want: "would run: [foo]",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(execPrint),

interp.ExecHandlers(blocklistOneExec("foo")),

src: "foo",

want: "would run: [foo]",

{

opts: []interp.RunnerOption{

interp.ExecHandlers(

blocklistOneExec("foo"),

execPrint,

src: "foo",

want: "foo: blocklisted program",

{

opts: []interp.RunnerOption{

interp.OpenHandler(blocklistNondevOpen),

src: "echo foo >/dev/null; echo bar >/tmp/x",

want: "non-dev: /tmp/x",

{

opts: []interp.RunnerOption{

interp.OpenHandler(blocklistNondevOpen),

interp.CallHandler(func(ctx context.Context, args []string) ([]string, error) {

return []string{"echo", "blank"}, nil

}),

src: "echo foo >/dev/null; { bar; } && baz",

want: "blank\nblank\n",

{

opts: []interp.RunnerOption{

interp.CallHandler(func(ctx context.Context, args []string) ([]string, error) {

return append([]string{"echo", "run:"}, args...), nil

}),

src: "cd some-dir; cat foo; exit 1",

want: "run: cd some-dir\nrun: cat foo\nrun: exit 1\n",

{

opts: []interp.RunnerOption{

interp.CallHandler(func(ctx context.Context, args []string) ([]string, error) {

if args[0] == "echo" && len(args) > 2 {

return nil, fmt.Errorf("refusing to run echo builtin with multiple args")

}

return args, nil

}),

src: "echo foo; echo foo bar",

want: "foo\nrefusing to run echo builtin with multiple args",

{

opts: []interp.RunnerOption{

interp.ReadDirHandler(blocklistGlob),

src: "echo *",

want: "blocklisted: glob\n",

}

func TestRunnerHandlers(t *testing.T) {

t.Parallel()

p := syntax.NewParser()

for _, tc := range modCases {

t.Run(tc.name, func(t *testing.T) {

file := parse(t, p, tc.src)

var cb concBuffer

r, err := interp.New(interp.StdIO(nil, &cb, &cb))

if err != nil {

t.Fatal(err)

}

for _, opt := range tc.opts {

opt(r)

}

ctx := context.WithValue(context.Background(), runnerCtx, r)

if err := r.Run(ctx, file); err != nil {

cb.WriteString(err.Error())

}

got := cb.String()

if got != tc.want {

t.Fatalf("want:\n%q\ngot:\n%q", tc.want, got)

}

})

}

type readyBuffer struct {

buf bytes.Buffer

seenReady sync.WaitGroup

}

func (b *readyBuffer) Write(p []byte) (n int, err error) {

if string(p) == "ready\n" {

b.seenReady.Done()

return len(p), nil

}

return b.buf.Write(p)

}

func TestKillTimeout(t *testing.T) {

if testing.Short() {

t.Skip("sleeps and timeouts are slow")

}

if runtime.GOOS == "windows" {

t.Skip("skipping trap tests on windows")

}

t.Parallel()

tests := []struct {

src string

want string

killTimeout time.Duration

forcedKill bool

}{

// killed immediately

{

`sh -c "trap 'echo trapped; exit 0' INT; echo ready; for i in \$(seq 1 100); do sleep 0.01; done"`,

"",

-1,

true,

// interrupted first, and stops itself in time

{

`sh -c "trap 'echo trapped; exit 0' INT; echo ready; for i in \$(seq 1 100); do sleep 0.01; done"`,

"trapped\n",

time.Second,

false,

// interrupted first, but does not stop itself in time

{

`sh -c "trap 'echo trapped; for i in \$(seq 1 100); do sleep 0.01; done' INT; echo ready; for i in \$(seq 1 100); do sleep 0.01; done"`,

"trapped\n",

20 * time.Millisecond,

true,

}

for _, test := range tests {

test := test

t.Run("", func(t *testing.T) {

t.Parallel()

file := parse(t, nil, test.src)

attempt := 0

for {

var rbuf readyBuffer

rbuf.seenReady.Add(1)

ctx, cancel := context.WithCancel(context.Background())

r, err := interp.New(

interp.StdIO(nil, &rbuf, &rbuf),

interp.ExecHandler(interp.DefaultExecHandler(test.killTimeout)),

)

if err != nil {

t.Fatal(err)

}

go func() {

rbuf.seenReady.Wait()

cancel()

}()

err = r.Run(ctx, file)

if test.forcedKill {

if _, ok := interp.IsExitStatus(err); ok || err == nil {

t.Error("command was not force-killed")

}

} else {

if err != nil && err != context.Canceled && err != context.DeadlineExceeded {

t.Errorf("execution errored: %v", err)

}

got := rbuf.buf.String()

if got != test.want {

if attempt < 3 && got == "" && test.killTimeout > 0 {

attempt++

test.killTimeout *= 2

continue

}

t.Fatalf("want:\n%s\ngot:\n%s", test.want, got)

}

break

}

})

}

func TestKillSignal(t *testing.T) {

if runtime.GOOS == "windows" {

t.Skip("skipping signal tests on windows")

}

tests := []struct {

signal os.Signal

want error

}{

{syscall.SIGINT, interp.NewExitStatus(130)}, // 128 + 2

{syscall.SIGKILL, interp.NewExitStatus(137)}, // 128 + 9

{syscall.SIGTERM, interp.NewExitStatus(143)}, // 128 + 15

}

// pid_and_hang is implemented in TestMain; we use it to have the

// interpreter spawn a process, and easily grab its PID to send it a

// signal directly. The program prints its PID and hangs forever.

file := parse(t, nil, "GOSH_CMD=pid_and_hang $GOSH_PROG")

for _, test := range tests {

test := test

t.Run(fmt.Sprintf("signal-%d", test.signal), func(t *testing.T) {

t.Parallel()

ctx, cancel := context.WithTimeout(context.Background(), time.Second)

defer cancel()

outReader, outWriter := io.Pipe()

stderr := new(bytes.Buffer)

r, _ := interp.New(interp.StdIO(nil, outWriter, stderr))

errch := make(chan error, 1)

go func() {

errch <- r.Run(ctx, file)

outWriter.Close()

}()

br := bufio.NewReader(outReader)

line, err := br.ReadString('\n')

if err != nil {

t.Fatal(err)

}

pid, err := strconv.Atoi(strings.TrimSpace(line))

if err != nil {

t.Fatal(err)

}

proc, err := os.FindProcess(pid)

if err != nil {

t.Fatal(err)

}

if err := proc.Signal(test.signal); err != nil {

t.Fatal(err)

}

if got := <-errch; got != test.want {

t.Fatalf("want error %v, got %v. stderr: %s", test.want, got, stderr)

}

})

}

sh/interp/handler_test.go at master · gitclone-url/sh · GitHub

Expand file tree

Breadcrumbs

handler_test.go

Latest commit

History

Breadcrumbs

handler_test.go

File metadata and controls