go.etcd.io/bbolt v1.3.9: Open

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 go.etcd.io/bbolt.Open in pkg:golang/go.etcd.io/bbolt@v1.3.9
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/go.etcd.io/bbolt@v1.3.9
Demonstrate these symbols/APIs:
  - go.etcd.io/bbolt.Open

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:57f3cb1ab83635d33c342f3ae9ff4140bbcabb79ec94d3c6c858b7d998de7979","contract":["bbolt.Open opens or creates a Bolt database file at the specified path with file mode","bbolt.DB allows reading and writing key-value pairs in buckets","bbolt.Open with Options.ReadOnly opens the database in read-only mode","bbolt.DB.Update returns bbolt.ErrDatabaseReadOnly when database is opened in read-only mode","bbolt.DB.Close closes the database file and releases locks"],"goal":"verify go.etcd.io/bbolt.Open in pkg:golang/go.etcd.io/bbolt@v1.3.9","kind":"HOW","packages":["pkg:golang/go.etcd.io/bbolt@v1.3.9"],"schemaVersion":1,"symbols":["go.etcd.io/bbolt.Open"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/go.etcd.io/bbolt@v1.3.9"],"schemaVersion":1,"subject":"pkg:golang/go.etcd.io/bbolt@v1.3.9","symbols":["go.etcd.io/bbolt.Open"],"verifierAdapter":"golang@1"}

module sample

go 1.22

require go.etcd.io/bbolt v1.3.9

require golang.org/x/sys v0.4.0 // indirect

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=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
go.etcd.io/bbolt v1.3.9 h1:8x7aARPEXiXbHmtUwAIv7eV2fQFHrLLavdiJ3uzJXoI=
go.etcd.io/bbolt v1.3.9/go.mod h1:zaO32+Ti0PK1ivdPtgMESzuzL2VPoIG1PCQNvOdo/dE=
golang.org/x/sync v0.5.0 h1:60k92dhOjHxJkrqnwsfl8KuaHbn/5dl0lUPUklKo3qE=
golang.org/x/sync v0.5.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18=
golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package sample

import (
	"errors"
	"fmt"
	"time"

	bolt "go.etcd.io/bbolt"
)

// OpenDatabase opens a Bolt key-value database with the given options.
func OpenDatabase(path string, readOnly bool, timeout time.Duration) (*bolt.DB, error) {
	opts := &bolt.Options{
		ReadOnly: readOnly,
		Timeout:  timeout,
	}
	return bolt.Open(path, 0600, opts)
}

// PutValue writes a key-value pair to a specified bucket.
func PutValue(db *bolt.DB, bucketName, key, value string) error {
	return db.Update(func(tx *bolt.Tx) error {
		b, err := tx.CreateBucketIfNotExists([]byte(bucketName))
		if err != nil {
			return fmt.Errorf("create bucket: %w", err)
		}
		return b.Put([]byte(key), []byte(value))
	})
}

// GetValue reads a key from a specified bucket.
func GetValue(db *bolt.DB, bucketName, key string) (string, error) {
	var val string
	err := db.View(func(tx *bolt.Tx) error {
		b := tx.Bucket([]byte(bucketName))
		if b == nil {
			return errors.New("bucket not found")
		}
		data := b.Get([]byte(key))
		if data == nil {
			return errors.New("key not found")
		}
		val = string(data)
		return nil
	})
	return val, err
}

// CloseDatabase closes the opened Bolt database.
func CloseDatabase(db *bolt.DB) error {
	if db == nil {
		return nil
	}
	return db.Close()
}

{
  "schemaVersion": 1,
  "goal": "verify go.etcd.io/bbolt.Open in pkg:golang/go.etcd.io/bbolt@v1.3.9",
  "kind": "HOW",
  "packages": [
    "pkg:golang/go.etcd.io/bbolt@v1.3.9"
  ],
  "symbols": [
    "go.etcd.io/bbolt.Open"
  ]
}

package main

import (
	"errors"
	"fmt"
	"os"
	"path/filepath"
	"time"

	bolt "go.etcd.io/bbolt"
	"sample"
)

func main() {
	tmpDir, err := os.MkdirTemp("", "bbolt-test-*")
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to create temp dir: %v\n", err)
		os.Exit(1)
	}
	defer os.RemoveAll(tmpDir)

	dbPath := filepath.Join(tmpDir, "test.db")

	// Assertion 1: bbolt.Open opens or creates a Bolt database file at the specified path with file mode
	db, err := sample.OpenDatabase(dbPath, false, 1*time.Second)
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to open database: %v\n", err)
		os.Exit(1)
	}
	if db == nil {
		fmt.Fprintf(os.Stderr, "expected db instance, got nil\n")
		os.Exit(1)
	}
	var _ *bolt.DB = db

	// Check file created on disk
	if _, err := os.Stat(dbPath); os.IsNotExist(err) {
		fmt.Fprintf(os.Stderr, "database file was not created: %v\n", err)
		os.Exit(1)
	}

	// Assertion 2: bbolt.DB allows reading and writing key-value pairs in buckets
	bucketName := "settings"
	key := "theme"
	expectedVal := "dark"

	if err := sample.PutValue(db, bucketName, key, expectedVal); err != nil {
		fmt.Fprintf(os.Stderr, "PutValue failed: %v\n", err)
		os.Exit(1)
	}

	val, err := sample.GetValue(db, bucketName, key)
	if err != nil {
		fmt.Fprintf(os.Stderr, "GetValue failed: %v\n", err)
		os.Exit(1)
	}
	if val != expectedVal {
		fmt.Fprintf(os.Stderr, "expected value %q, got %q\n", expectedVal, val)
		os.Exit(1)
	}

	// Assertion 3: bbolt.DB.Close closes the database file and releases locks
	if err := sample.CloseDatabase(db); err != nil {
		fmt.Fprintf(os.Stderr, "CloseDatabase failed: %v\n", err)
		os.Exit(1)
	}

	// Assertion 4: bbolt.Open with Options.ReadOnly opens the database in read-only mode
	roDB, err := sample.OpenDatabase(dbPath, true, 1*time.Second)
	if err != nil {
		fmt.Fprintf(os.Stderr, "failed to open database in read-only mode: %v\n", err)
		os.Exit(1)
	}
	defer sample.CloseDatabase(roDB)

	// Can read existing data
	roVal, err := sample.GetValue(roDB, bucketName, key)
	if err != nil {
		fmt.Fprintf(os.Stderr, "GetValue in read-only mode failed: %v\n", err)
		os.Exit(1)
	}
	if roVal != expectedVal {
		fmt.Fprintf(os.Stderr, "expected read-only value %q, got %q\n", expectedVal, roVal)
		os.Exit(1)
	}

	// Assertion 5: bbolt.DB in read-only mode rejects write transactions with bbolt.ErrDatabaseReadOnly
	writeErr := sample.PutValue(roDB, bucketName, "newKey", "newValue")
	if writeErr == nil {
		fmt.Fprintf(os.Stderr, "expected write transaction in read-only mode to fail, but it succeeded\n")
		os.Exit(1)
	}
	if !errors.Is(writeErr, bolt.ErrDatabaseReadOnly) {
		fmt.Fprintf(os.Stderr, "expected ErrDatabaseReadOnly, got %v\n", writeErr)
		os.Exit(1)
	}

	fmt.Println("All bbolt contract assertions passed.")
}