Files
onyx/tools/ods/internal/postgres/postgres.go
roshanandDevin AI 4a23402d70 chore(ods): remove unused IsPortExposed and NewConfigFromEnv helpers (#16263)
## Description

This PR removes two ODS helpers. Their last production callers were
removed in #16246.

- `docker.IsPortExposed` (`tools/ods/internal/docker/docker.go`) and its
test `TestIsPortExposed`.
- `postgres.NewConfigFromEnv`
(`tools/ods/internal/postgres/postgres.go`). Callers now use
`NewConfigFromEnvironment(env)`. The two `NewConfigFromEnv` tests now
call `NewConfigFromEnvironment`, so the tests for the default values and
for reading the environment stay.

## How Has This Been Tested?

- `go vet` and `go test ./internal/docker ./internal/postgres`
- `GOOS=windows go build ./...`
- Pre-commit hooks (`golangci-lint`) on the changed files.

## Additional Options

- [ ] [Optional] Please cherry-pick this PR to the latest release
version.

Link to Devin session:
https://app.devin.ai/sessions/88808bbde64f4f1ebe92163a49564dbe
Open in Devin Desktop:
https://app.devin.ai/desktop/session/88808bbde64f4f1ebe92163a49564dbe?variant=devin

<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
Removes two unused ODS helpers now that their last production callers
were deleted in #16246. Deletes `docker.IsPortExposed` and its test, and
drops `postgres.NewConfigFromEnv`; the tests for default values and
environment reading now call `NewConfigFromEnvironment` directly.

**Migration**
- Code still calling `postgres.NewConfigFromEnv()` should use
`NewConfigFromEnvironment(os.Environ())`.

<sup>Written for commit 0a2c413df7.
Summary will update on new commits.</sup>

<a
href="https://cubic.dev/pr/onyx-dot-app/onyx/pull/16263?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="View guided diff"
src="https://www.cubic.dev/buttons/review-in-cubic-light.svg"></picture></a>
<a
href="https://www.cubic.dev/action/auto-fix/pr/onyx-dot-app/onyx/16263?returnTo=https%3A%2F%2Fgithub.com%2Fonyx-dot-app%2Fonyx%2Fpull%2F16263&source=description"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"><img
alt="Turn on auto-fix"
src="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"></picture></a>

<!-- End of auto-generated description by cubic. -->



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Refactor**
* Streamlined internal Docker and PostgreSQL utilities. PostgreSQL
configuration checks now use explicitly supplied environment values
rather than reading process settings directly.
  * No end-user-facing behavior changes are included in this update.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-10-19 20:34:29 +00:00

109 lines
2.4 KiB
Go

package postgres
import (
"net"
"net/url"
"strings"
)
// Config holds PostgreSQL connection configuration.
type Config struct {
User string
Password string
Host string
Port string
Database string
}
// Default values for PostgreSQL connection
const (
DefaultUser = "postgres"
DefaultPassword = "password"
DefaultHost = "localhost"
DefaultPort = "5432"
DefaultDatabase = "postgres"
)
func IsLoopbackHost(host string) bool {
host = strings.TrimSuffix(strings.TrimSpace(host), ".")
if strings.EqualFold(host, "localhost") {
return true
}
if strings.HasPrefix(host, "[") && strings.HasSuffix(host, "]") {
host = host[1 : len(host)-1]
}
return net.ParseIP(host).IsLoopback()
}
// NewConfigFromEnvironment reads a private runtime environment without changing the process.
func NewConfigFromEnvironment(env []string) *Config {
config := &Config{User: DefaultUser, Password: DefaultPassword, Host: DefaultHost, Port: DefaultPort, Database: DefaultDatabase}
for _, entry := range env {
key, value, ok := strings.Cut(entry, "=")
if !ok || value == "" {
continue
}
switch key {
case "POSTGRES_USER":
config.User = value
case "POSTGRES_PASSWORD":
config.Password = value
case "POSTGRES_HOST":
config.Host = value
case "POSTGRES_PORT":
config.Port = value
case "POSTGRES_DB":
config.Database = value
}
}
return config
}
// ConnectionString returns a PostgreSQL connection string.
func (c *Config) ConnectionString() string {
u := url.URL{
Scheme: "postgresql",
User: url.UserPassword(c.User, c.Password),
Host: net.JoinHostPort(c.Host, c.Port),
Path: "/" + c.Database,
}
return u.String()
}
// PgDumpArgs returns common arguments for pg_dump.
func (c *Config) PgDumpArgs(format string) []string {
args := []string{
"-U", c.User,
"-d", c.Database,
}
if format == "custom" {
args = append(args, "-Fc")
} else {
args = append(args, "-Fp")
}
return args
}
// PgRestoreArgs returns common arguments for pg_restore.
func (c *Config) PgRestoreArgs() []string {
return []string{
"-U", c.User,
"-d", c.Database,
}
}
// PsqlArgs returns common arguments for psql.
func (c *Config) PsqlArgs() []string {
return []string{
"-U", c.User,
"-d", c.Database,
}
}
// Env returns environment variables for PostgreSQL commands.
func (c *Config) Env() map[string]string {
return map[string]string{
"PGPASSWORD": c.Password,
}
}