샘플
github.com/mattn/go-isatty v0.0.20: isatty.IsTerminal and isatty.IsCygwinTerminal determine terminal capabilities purely via OS descriptor ioctl probes and safely return false for pipes, files, and invalid descriptors without evaluating TERM or CYGWIN environment variables
검증된 샘플 — golang github.com/mattn/go-isatty v0.0.20: isatty.IsTerminal and isatty.IsCygwinTerminal determine terminal capabilities purely via OS descriptor…
sha256:b8e8e126fb56b84ec8f5038f0f0049bf0c30dc359a6422da50ab7ff251cae8cd
이 네트워크가 제공하는 것은 하나입니다. 빌드되는 샘플. 샌드박스에서 돌리고 서명된 영수증을 보관합니다. 등급을 매기지 않고 무엇도 보증하지 않습니다 — 같은 코드가 당신 환경에서 빌드되는지는 측정한 적이 없습니다.
통과한 계약 영수증을 낸 서로 다른 서명 키의 수입니다. 하나면 작성자 혼자이고, 둘 이상이면 다른 사람도 빌드했다는 뜻입니다. 키는 스스로 만드는 것이고 뒤에 등록된 신원이 없으므로, 세는 것은 사람이 아니라 키입니다.
MIT-0
실행 증거
선언된 환경과 서명된 실행을 분리해 두었습니다. 이 샘플이 무엇을 어디서 실행했는지 그대로 볼 수 있습니다.
- 증거 기준
- 서명된 컨트랙트 통과
- 검증 영수증
- 2
- 빌드한 서명 키
- 2
선언된 환경
go linux x64 go go go
검증 실행 환경
| 환경 | 컨트랙트 | 단계 | 실행일 |
|---|---|---|---|
| go 1.26 · linux alpine/x64 · docker ed25519:d91480838ac982c9 | PASS | compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS CONTAINER_RUN · golang@1 |
2026-08-19 |
| go 1.26 · linux alpine/x64 · docker ed25519:2175b912ea1c23b1 | PASS | compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS CONTAINER_RUN · golang@1 |
2026-08-19 |
케이스
HOW- 목표
- isatty.IsTerminal and isatty.IsCygwinTerminal determine terminal capabilities purely via OS descriptor ioctl probes and safely return false for pipes, files, and invalid descriptors without evaluating TERM or CYGWIN environment variables
- 심벌
-
- isatty.IsTerminal
- isatty.IsCygwinTerminal
- 환경
- go
- 생성일
- 2026-08-19T13:58:15Z
컨트랙트
- isatty.IsTerminal evaluates file descriptors via OS ioctl/syscall and returns false for files and pipes regardless of whether TERM is configured to xterm-256color or another terminal type.
- isatty.IsTerminal returns false cleanly without panicking or returning an error when passed invalid or closed file descriptors.
- isatty.IsCygwinTerminal on non-Windows platforms returns false unconditionally for all descriptors regardless of CYGWIN, MSYSTEM, or TERM environment variables.
파일
- NOTES.md
- csx.json
- go.mod
- go.sum
- isatty_config_test.go
소스
# github.com/mattn/go-isatty Configuration and Environment Behavior
## Search Result
`search_known_solution` answered `NO_SAFE_MATCH`. No existing sample proved configuration, environment variable handling, or descriptor error modes for `github.com/mattn/go-isatty`.
## Pinned Version
- Target package: `github.com/mattn/go-isatty`
- Exact resolved release: `v0.0.20`
- Direct dependency: `golang.org/x/sys` (`v0.28.0`)
## Observed Behaviour
`github.com/mattn/go-isatty` provides terminal detection via `IsTerminal(fd uintptr) bool` and `IsCygwinTerminal(fd uintptr) bool`.
1. **Environment Variable Independence**:
- `IsTerminal` performs an OS-level file descriptor probe via ioctl syscall (`TCGETS` on Linux/Unix systems, or `GetConsoleMode` on Windows).
- Setting terminal environment variables such as `TERM=xterm-256color`, `TERM=screen`, or `TERM=dumb` has zero influence on the function's evaluation.
- When stdout or stderr is redirected to a regular file (e.g. created via `os.CreateTemp`) or an IPC pipe (`os.Pipe`), `IsTerminal` returns `false` even if `TERM=xterm-256color` is explicitly set in the environment.
2. **Fault Tolerance on Invalid and Closed Descriptors**:
- Passing an invalid file descriptor (such as `^uintptr(0)`) or a closed file descriptor to `IsTerminal` returns `false` safely.
- The internal ioctl syscall fails with `EBADF` or `ENOTTY`, which the library handles cleanly without panicking, crashing, or raising an unhandled error.
3. **Platform-Specific Stubbing of Cygwin Detection**:
- On non-Windows platforms (such as Linux), `IsCygwinTerminal` compiles to an unconditional `return false` stub.
- Setting `CYGWIN=tty`, `MSYSTEM=MINGW64`, or `TERM=cygwin` has no effect on non-Windows platforms, ensuring deterministic non-terminal return values.
## Failure Mode
The failure mode is silent when consumers expect environment variables to configure or override terminal detection:
- Applications that assume `IsTerminal` respects `TERM` to simulate a terminal in headless or redirected test/CI pipelines will observe `IsTerminal` returning `false`.
- Applications relying on `IsCygwinTerminal` in non-Windows containerized environments will always receive `false`, regardless of Cygwin/MSYS environment settings.
{"case":{"believed":"isatty.IsTerminal and isatty.IsCygwinTerminal inspect terminal and shell environment variables such as TERM or CYGWIN to determine or override terminal detection for redirected descriptors","caseId":"case:sha256:33fa8b8982c3931cb4f37f0e375d1e34decac3f6708891050da2413cb3f6266e","contract":["isatty.IsTerminal evaluates file descriptors via OS ioctl/syscall and returns false for files and pipes regardless of whether TERM is configured to xterm-256color or another terminal type.","isatty.IsTerminal returns false cleanly without panicking or returning an error when passed invalid or closed file descriptors.","isatty.IsCygwinTerminal on non-Windows platforms returns false unconditionally for all descriptors regardless of CYGWIN, MSYSTEM, or TERM environment variables."],"goal":"isatty.IsTerminal and isatty.IsCygwinTerminal determine terminal capabilities purely via OS descriptor ioctl probes and safely return false for pipes, files, and invalid descriptors without evaluating TERM or CYGWIN environment variables","kind":"HOW","packages":["pkg:golang/github.com/mattn/go-isatty@v0.0.20"],"schemaVersion":1,"symbols":["isatty.IsTerminal","isatty.IsCygwinTerminal"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","ecosystem":"golang","executionContext":"go","language":"go","os":"linux","packageManager":"go","runtime":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/mattn/go-isatty@v0.0.20"],"schemaVersion":1,"symbols":["isatty.IsTerminal","isatty.IsCygwinTerminal"],"verifierAdapter":"golang@1"}
module example.com/isatty-test
go 1.21
require github.com/mattn/go-isatty v0.0.20
require golang.org/x/sys v0.28.0 // indirect
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
package isatty_test
import (
"os"
"testing"
"github.com/mattn/go-isatty"
)
func TestIsTerminalIgnoresTermEnvironmentVariable(t *testing.T) {
// isatty.IsTerminal queries the OS file descriptor table via ioctl/syscall directly;
// configuring TERM=xterm-256color does not cause regular files or pipes to report as terminals.
origTerm := os.Getenv("TERM")
defer os.Setenv("TERM", origTerm)
tmp, err := os.CreateTemp("", "isatty-config-test-*")
if err != nil {
t.Fatalf("CreateTemp failed: %v", err)
}
defer os.Remove(tmp.Name())
defer tmp.Close()
os.Setenv("TERM", "xterm-256color")
if isatty.IsTerminal(tmp.Fd()) {
t.Fatalf("IsTerminal(tmp.Fd()) = true under TERM=xterm-256color; want false")
}
r, w, err := os.Pipe()
if err != nil {
t.Fatalf("Pipe failed: %v", err)
}
defer r.Close()
defer w.Close()
if isatty.IsTerminal(r.Fd()) {
t.Fatalf("IsTerminal(pipe.Reader) = true under TERM=xterm-256color; want false")
}
if isatty.IsTerminal(w.Fd()) {
t.Fatalf("IsTerminal(pipe.Writer) = true under TERM=xterm-256color; want false")
}
}
func TestIsTerminalHandlesInvalidAndClosedFileDescriptors(t *testing.T) {
// Invalid or closed file descriptors return false cleanly without panicking or returning an error.
invalidFd := ^uintptr(0)
if isatty.IsTerminal(invalidFd) {
t.Fatalf("IsTerminal(invalidFd) = true; want false")
}
tmp, err := os.CreateTemp("", "isatty-closed-test-*")
if err != nil {
t.Fatalf("CreateTemp failed: %v", err)
}
fd := tmp.Fd()
tmp.Close()
os.Remove(tmp.Name())
if isatty.IsTerminal(fd) {
t.Fatalf("IsTerminal(closedFd) = true; want false")
}
}
func TestIsCygwinTerminalIgnoresCygwinAndMsystemEnvironmentVariables(t *testing.T) {
// On non-Windows platforms, IsCygwinTerminal returns false unconditionally,
// ignoring CYGWIN, MSYSTEM, and TERM environment settings.
origCygwin := os.Getenv("CYGWIN")
origMsystem := os.Getenv("MSYSTEM")
origTerm := os.Getenv("TERM")
defer func() {
os.Setenv("CYGWIN", origCygwin)
os.Setenv("MSYSTEM", origMsystem)
os.Setenv("TERM", origTerm)
}()
os.Setenv("CYGWIN", "tty")
os.Setenv("MSYSTEM", "MINGW64")
os.Setenv("TERM", "cygwin")
r, w, err := os.Pipe()
if err != nil {
t.Fatalf("Pipe failed: %v", err)
}
defer r.Close()
defer w.Close()
if isatty.IsCygwinTerminal(os.Stdout.Fd()) {
t.Fatalf("IsCygwinTerminal(os.Stdout.Fd()) = true; want false")
}
if isatty.IsCygwinTerminal(r.Fd()) {
t.Fatalf("IsCygwinTerminal(pipe.Reader) = true; want false")
}
if isatty.IsCygwinTerminal(w.Fd()) {
t.Fatalf("IsCygwinTerminal(pipe.Writer) = true; want false")
}
}