golang.org/x/term v0.0.0-20210927222741-03fcf44c2211: MakeRaw

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify term.MakeRaw in pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211
Demonstrate these symbols/APIs:
  - term.MakeRaw
Required runtime conditions:
  - ecosystem: golang
  - language: go
  - packageManager: go@1.26.6
  - runtime: go@1.26.6

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:7ab061d632edfb41f7823cc8f357550ce26d2ebd42b67639189ff97aae665d7a","contract":["term.MakeRaw returns an error for negative or invalid file descriptors","term.MakeRaw returns an error for pipe file descriptors","term.MakeRaw returns an error for regular file descriptors","term.MakeRaw returns an error for /dev/null device descriptors","term.MakeRaw configures terminal into raw mode and term.Restore restores terminal state"],"goal":"verify term.MakeRaw in pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211","kind":"HOW","packages":["pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211"],"schemaVersion":1,"symbols":["term.MakeRaw"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211"],"schemaVersion":1,"subject":"pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211","symbols":["term.MakeRaw"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.26.6

require golang.org/x/term v0.0.0-20210927222741-03fcf44c2211

require golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1 // indirect

golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1 h1:SrN+KX8Art/Sf4HNj6Zcz06G7VEz+7w9tdXTPOZ7+l4=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=

package main

import (
	"fmt"
	"os"
	"syscall"

	"golang.org/x/term"
)

func main() {
	fd := int(os.Stdin.Fd())
	if term.IsTerminal(fd) {
		oldState, err := term.MakeRaw(fd)
		if err != nil {
			fmt.Fprintf(os.Stderr, "Failed to make terminal raw: %v\n", err)
			os.Exit(1)
		}
		defer term.Restore(fd, oldState)
		fmt.Println("Terminal switched to raw mode and restored")
	} else {
		_, err := term.MakeRaw(fd)
		if err != nil {
			fmt.Printf("Non-terminal descriptor returned expected error: %v\n", err)
		}
	}

	ptmx, err := os.OpenFile("/dev/ptmx", os.O_RDWR|syscall.O_NOCTTY, 0)
	if err == nil {
		defer ptmx.Close()
		state, err := term.MakeRaw(int(ptmx.Fd()))
		if err != nil {
			fmt.Fprintf(os.Stderr, "Failed to make ptmx raw: %v\n", err)
			os.Exit(1)
		}
		if err := term.Restore(int(ptmx.Fd()), state); err != nil {
			fmt.Fprintf(os.Stderr, "Failed to restore ptmx state: %v\n", err)
			os.Exit(1)
		}
		fmt.Println("PTY terminal raw mode verified")
	}
}

{
  "schemaVersion": 1,
  "goal": "verify term.MakeRaw in pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211",
  "kind": "HOW",
  "packages": [
    "pkg:golang/golang.org/x/term@v0.0.0-20210927222741-03fcf44c2211"
  ],
  "symbols": [
    "term.MakeRaw"
  ],
  "runtimeConditions": {
    "ecosystem": "golang",
    "language": "go",
    "packageManager": "go@1.26.6",
    "runtime": "go@1.26.6"
  }
}

package main

import (
	"fmt"
	"os"
	"syscall"

	"golang.org/x/term"
)

func main() {
	// Assertion 1: term.MakeRaw returns an error for negative or invalid file descriptors
	if state, err := term.MakeRaw(-1); err == nil {
		fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw(-1) succeeded unexpectedly, state=%v\n", state)
		os.Exit(1)
	}

	// Assertion 2: term.MakeRaw returns an error for pipe file descriptors
	r, w, err := os.Pipe()
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: os.Pipe failed: %v\n", err)
		os.Exit(1)
	}
	defer r.Close()
	defer w.Close()

	if state, err := term.MakeRaw(int(r.Fd())); err == nil {
		fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw on pipe reader succeeded unexpectedly, state=%v\n", state)
		os.Exit(1)
	}
	if state, err := term.MakeRaw(int(w.Fd())); err == nil {
		fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw on pipe writer succeeded unexpectedly, state=%v\n", state)
		os.Exit(1)
	}

	// Assertion 3: term.MakeRaw returns an error for regular file descriptors
	tmpFile, err := os.CreateTemp("", "term-makeraw-test-*")
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: os.CreateTemp failed: %v\n", err)
		os.Exit(1)
	}
	defer os.Remove(tmpFile.Name())
	defer tmpFile.Close()

	if state, err := term.MakeRaw(int(tmpFile.Fd())); err == nil {
		fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw on regular file succeeded unexpectedly, state=%v\n", state)
		os.Exit(1)
	}

	// Assertion 4: term.MakeRaw returns an error for /dev/null device descriptors
	devNull, err := os.Open(os.DevNull)
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: open /dev/null failed: %v\n", err)
		os.Exit(1)
	}
	defer devNull.Close()

	if state, err := term.MakeRaw(int(devNull.Fd())); err == nil {
		fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw on /dev/null succeeded unexpectedly, state=%v\n", state)
		os.Exit(1)
	}

	// Assertion 5: term.MakeRaw configures terminal into raw mode and term.Restore restores terminal state
	ptmx, err := os.OpenFile("/dev/ptmx", os.O_RDWR|syscall.O_NOCTTY, 0)
	if err != nil {
		if err := term.Restore(-1, nil); err == nil {
			fmt.Fprintf(os.Stderr, "FAIL: term.Restore(-1, nil) succeeded unexpectedly\n")
			os.Exit(1)
		}
	} else {
		defer ptmx.Close()
		state, err := term.MakeRaw(int(ptmx.Fd()))
		if err != nil {
			fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw(ptmx) failed: %v\n", err)
			os.Exit(1)
		}
		if state == nil {
			fmt.Fprintf(os.Stderr, "FAIL: term.MakeRaw(ptmx) returned nil state\n")
			os.Exit(1)
		}
		if err := term.Restore(int(ptmx.Fd()), state); err != nil {
			fmt.Fprintf(os.Stderr, "FAIL: term.Restore(ptmx) failed: %v\n", err)
			os.Exit(1)
		}
	}

	fmt.Println("PASS: golang.org/x/term term.MakeRaw contract passed")
}