refactor: Rename pg-related environment variables to gauss

happy-game · happy-game · commit fcbba144e797 · 2025-06-05T16:09:16.000+08:00
- Skip pg-native tests
diff --git a/.devcontainer/docker-compose.yml b/.devcontainer/docker-compose.yml
@@ -21,13 +21,13 @@ services:
       - ..:/workspace:cached
 
     environment:
-      PGPASSWORD: openGauss@123
-      PGUSER: gaussdb
-      PGDATABASE: data
-      PGHOST: db
+      GAUSSPASSWORD: openGauss@123
+      GAUSSUSER: gaussdb
+      GAUSSDATABASE: data
+      GAUSSHOST: db
       # set this to true in the development environment until I can get SSL setup on the 
       # docker postgres instance
-      PGTESTNOSSL: 'true'
+      GAUSSTESTNOSSL: 'true'
       
     # Overrides default command so things don't shut down after the process ends.
     command: sleep infinity
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -51,13 +51,13 @@ jobs:
     name: Node.js ${{ matrix.node }}
     runs-on: ubuntu-latest
     env:
-      PGUSER: ci_user
-      PGPASSWORD: openGauss@123
-      PGHOST: localhost
-      PGDATABASE: ci_db_test
-      PGTESTNOSSL: 'true'
-      SHA256_TEST_PGUSER: sha256_test
-      SHA256_TEST_PGPASSWORD: test4@scram
+      GAUSSUSER: ci_user
+      GAUSSPASSWORD: openGauss@123
+      GAUSSHOST: localhost
+      GAUSSDATABASE: ci_db_test
+      GAUSSTESTNOSSL: 'true'
+      SHA256_TEST_GAUSSUSER: sha256_test
+      SHA256_TEST_GAUSSPASSWORD: test4@scram
     steps:
       - name: Show OS
         run: |
diff --git a/packages/gaussdb/lib/client.js b/packages/gaussdb/lib/client.js
@@ -112,6 +112,7 @@ class Client extends EventEmitter {
     }
 
     if (this.host && this.host.indexOf('/') === 0) {
+      // TODO: is GaussDB using domain sockets?
       con.connect(this.host + '/.s.PGSQL.' + this.port)
     } else {
       con.connect(this.port, this.host)
@@ -475,6 +476,7 @@ class Client extends EventEmitter {
       const con = this.connection
 
       if (this.host && this.host.indexOf('/') === 0) {
+        // TODO: is GaussDB using domain sockets?
         con.connect(this.host + '/.s.PGSQL.' + this.port)
       } else {
         con.connect(this.port, this.host)
diff --git a/packages/gaussdb/lib/connection-parameters.js b/packages/gaussdb/lib/connection-parameters.js
@@ -8,7 +8,7 @@ const parse = require('gaussdb-connection-string').parse // parses a connection
 
 const val = function (key, config, envVar) {
   if (envVar === undefined) {
-    envVar = process.env['PG' + key.toUpperCase()]
+    envVar = process.env['GAUSS' + key.toUpperCase()]
   } else if (envVar === false) {
     // do nothing ... use false
   } else {
@@ -19,7 +19,7 @@ const val = function (key, config, envVar) {
 }
 
 const readSSLConfigFromEnvironment = function () {
-  switch (process.env.PGSSLMODE) {
+  switch (process.env.GAUSSSSLMODE) {
     case 'disable':
       return false
     case 'prefer':
@@ -100,15 +100,15 @@ class ConnectionParameters {
     // a domain socket begins with '/'
     this.isDomainSocket = !(this.host || '').indexOf('/')
 
-    this.application_name = val('application_name', config, 'PGAPPNAME')
+    this.application_name = val('application_name', config, 'GAUSSAPPNAME')
     this.fallback_application_name = val('fallback_application_name', config, false)
     this.statement_timeout = val('statement_timeout', config, false)
     this.lock_timeout = val('lock_timeout', config, false)
     this.idle_in_transaction_session_timeout = val('idle_in_transaction_session_timeout', config, false)
     this.query_timeout = val('query_timeout', config, false)
 
     if (config.connectionTimeoutMillis === undefined) {
-      this.connect_timeout = process.env.PGCONNECT_TIMEOUT || 0
+      this.connect_timeout = process.env.GAUSSCONNECT_TIMEOUT || 0
     } else {
       this.connect_timeout = Math.floor(config.connectionTimeoutMillis / 1000)
     }
diff --git a/packages/gaussdb/lib/index.js b/packages/gaussdb/lib/index.js
@@ -34,6 +34,7 @@ const GAUSSDB = function (clientConstructor) {
   this.utils = utils
 }
 
+// TODO: NODE_PG_FORCE_NATIVE or NODE_GAUSS_FORCE_NATIVE
 if (typeof process.env.NODE_PG_FORCE_NATIVE !== 'undefined') {
   module.exports = new GAUSSDB(require('./native'))
 } else {
diff --git a/packages/gaussdb/test/cli.js b/packages/gaussdb/test/cli.js
@@ -18,7 +18,7 @@ for (let i = 0; i < process.argv.length; i++) {
   }
 }
 
-if (process.env['PG_TEST_NATIVE']) {
+if (process.env['GAUSS_TEST_NATIVE']) {
   config.native = true
 }
 
diff --git a/packages/gaussdb/test/integration/client/appname-tests.js b/packages/gaussdb/test/integration/client/appname-tests.js
@@ -87,9 +87,9 @@ suite.test('application_name from connection string', function (done) {
 // TODO: make the test work for native client too
 if (!helper.args.native) {
   suite.test('application_name is read from the env', function (done) {
-    const appName = (process.env.PGAPPNAME = 'testest')
+    const appName = (process.env.GAUSSAPPNAME = 'testest')
     getAppName({}, function (res) {
-      delete process.env.PGAPPNAME
+      delete process.env.GAUSSAPPNAME
       assert.strictEqual(res, appName)
       done()
     })
diff --git a/packages/gaussdb/test/integration/client/configuration-tests.js b/packages/gaussdb/test/integration/client/configuration-tests.js
@@ -10,7 +10,7 @@ const suite = new helper.Suite()
 const realEnv = {}
 for (const key in process.env) {
   realEnv[key] = process.env[key]
-  if (!key.indexOf('PG')) delete process.env[key]
+  if (!key.indexOf('GAUSS')) delete process.env[key]
 }
 
 suite.test('default values are used in new clients', function () {
diff --git a/packages/gaussdb/test/integration/client/sasl-scram-tests.js b/packages/gaussdb/test/integration/client/sasl-scram-tests.js
@@ -6,8 +6,8 @@ const { native } = helper.args
 const assert = require('assert')
 
 /**
- * This test only executes if the env variables SCRAM_TEST_PGUSER and
- * SCRAM_TEST_PGPASSWORD are defined. You can override additional values
+ * This test only executes if the env variables SCRAM_TEST_GAUSSUSER and
+ * SCRAM_TEST_GAUSSPASSWORD are defined. You can override additional values
  * for the host, port and database with other SCRAM_TEST_ prefixed vars.
  * If the variables are not defined the test will be skipped.
  *
@@ -23,17 +23,17 @@ const assert = require('assert')
  *
  * Then run this file with after exporting:
  *
- *     SCRAM_TEST_PGUSER=scram_test
- *     SCRAM_TEST_PGPASSWORD=test4scram
+ *     SCRAM_TEST_GAUSSUSER=scram_test
+ *     SCRAM_TEST_GAUSSPASSWORD=test4scram
  */
 
 // Base config for SCRAM tests
 const config = {
-  user: process.env.SCRAM_TEST_PGUSER,
-  password: process.env.SCRAM_TEST_PGPASSWORD,
-  host: process.env.SCRAM_TEST_PGHOST, // optional
-  port: process.env.SCRAM_TEST_PGPORT, // optional
-  database: process.env.SCRAM_TEST_PGDATABASE, // optional
+  user: process.env.SCRAM_TEST_GAUSSUSER,
+  password: process.env.SCRAM_TEST_GAUSSPASSWORD,
+  host: process.env.SCRAM_TEST_GAUSSHOST, // optional
+  port: process.env.SCRAM_TEST_GAUSSPORT, // optional
+  database: process.env.SCRAM_TEST_GAUSSDATABASE, // optional
 }
 
 if (native) {
@@ -92,7 +92,7 @@ suite.testAsync('sasl/scram fails when password is empty', async () => {
   const client = new gaussdb.Client({
     ...config,
     // We use a password function here so the connection defaults do not
-    // override the empty string value with one from process.env.PGPASSWORD
+    // override the empty string value with one from process.env.GAUSSPASSWORD
     password: () => '',
   })
   let usingSasl = false
diff --git a/packages/gaussdb/test/integration/client/sha256-password-tests.js b/packages/gaussdb/test/integration/client/sha256-password-tests.js
@@ -6,8 +6,8 @@ const { native } = helper.args
 const assert = require('assert')
 
 /**
- * This test only executes if the env variables SHA256_TEST_PGUSER and
- * SHA256_TEST_PGPASSWORD are defined. You can override additional values
+ * This test only executes if the env variables SHA256_TEST_GAUSSUSER and
+ * SHA256_TEST_GAUSSPASSWORD are defined. You can override additional values
  * for the host, port and database with other SHA256_TEST_ prefixed vars.
  * If the variables are not defined the test will be skipped.
  *
@@ -23,17 +23,17 @@ const assert = require('assert')
  *
  * Then run this file with after exporting:
  *
- *     SHA256_TEST_PGUSER=sha256_test
- *     SHA256_TEST_PGPASSWORD=test4@scram
+ *     SHA256_TEST_GAUSSUSER=sha256_test
+ *     SHA256_TEST_GAUSSPASSWORD=test4@scram
  */
 
 // Base config for SHA256 tests
 const config = {
-  user: process.env.SHA256_TEST_PGUSER,
-  password: process.env.SHA256_TEST_PGPASSWORD,
-  host: process.env.SHA256_TEST_PGHOST || 'localhost',
-  port: process.env.SHA256_TEST_PGPORT || 5432,
-  database: process.env.SHA256_TEST_PGDATABASE || 'ci_db_test',
+  user: process.env.SHA256_TEST_GAUSSUSER,
+  password: process.env.SHA256_TEST_GAUSSPASSWORD,
+  host: process.env.SHA256_TEST_GAUSSHOST || 'localhost',
+  port: process.env.SHA256_TEST_GAUSSPORT || 5432,
+  database: process.env.SHA256_TEST_GAUSSDATABASE || 'ci_db_test',
 }
 
 if (native) {
diff --git a/packages/gaussdb/test/integration/client/ssl-tests.js b/packages/gaussdb/test/integration/client/ssl-tests.js
@@ -5,7 +5,7 @@ const suite = new helper.Suite()
 
 // allow skipping of this test via env var for
 // local testing when you don't have SSL set up
-if (process.env.PGTESTNOSSL) {
+if (process.env.GAUSSTESTNOSSL) {
   return
 }
 
diff --git a/packages/gaussdb/test/integration/connection-pool/tls-tests.js b/packages/gaussdb/test/integration/connection-pool/tls-tests.js
@@ -7,13 +7,13 @@ const gaussdb = helper.gaussdb
 
 const suite = new helper.Suite()
 
-if (process.env.PG_CLIENT_CERT_TEST) {
+if (process.env.GAUSS_CLIENT_CERT_TEST) {
   suite.testAsync('client certificate', async () => {
     const pool = new gaussdb.Pool({
       ssl: {
-        ca: fs.readFileSync(process.env.PGSSLROOTCERT),
-        cert: fs.readFileSync(process.env.PGSSLCERT),
-        key: fs.readFileSync(process.env.PGSSLKEY),
+        ca: fs.readFileSync(process.env.GAUSSSSLROOTCERT),
+        cert: fs.readFileSync(process.env.GAUSSSSLCERT),
+        key: fs.readFileSync(process.env.GAUSSSSLKEY),
       },
     })
 
diff --git a/packages/gaussdb/test/integration/gh-issues/130-tests.js b/packages/gaussdb/test/integration/gh-issues/130-tests.js
@@ -1,3 +1,5 @@
+// TODO: skip because it use psql, PG-related environment is required
+/*
 'use strict'
 const helper = require('../test-helper')
 const exec = require('child_process').exec
@@ -27,3 +29,4 @@ pool.connect(function (err, client, done) {
     )
   })
 })
+*/
diff --git a/packages/gaussdb/test/integration/gh-issues/2085-tests.js b/packages/gaussdb/test/integration/gh-issues/2085-tests.js
@@ -6,7 +6,7 @@ const suite = new helper.Suite()
 
 // allow skipping of this test via env var for
 // local testing when you don't have SSL set up
-if (process.env.PGTESTNOSSL) {
+if (process.env.GAUSSTESTNOSSL) {
   return
 }
 
diff --git a/packages/gaussdb/test/unit/client/cleartext-password-tests.js b/packages/gaussdb/test/unit/client/cleartext-password-tests.js
@@ -18,7 +18,7 @@ suite.test('cleartext password auth responds with password', function () {
 })
 
 suite.test('cleartext password auth does not crash with null password using pg-pass', function () {
-  process.env.PGPASSFILE = `${__dirname}/pgpass.file`
+  process.env.GAUSSPASSFILE = `${__dirname}/pgpass.file`
   const client = new helper.Client({
     host: 'foo',
     port: 5432,
diff --git a/packages/gaussdb/test/unit/client/configuration-tests.js b/packages/gaussdb/test/unit/client/configuration-tests.js
diff --git a/packages/gaussdb/test/unit/connection-parameters/environment-variable-tests.js b/packages/gaussdb/test/unit/connection-parameters/environment-variable-tests.js
diff --git a/packages/pg-native/package.json b/packages/pg-native/package.json

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ const GAUSSDB = function (clientConstructor) {`
`34`	`34`	`this.utils = utils`
`35`	`35`	`}`
`36`	`36`
	`37`	`+// TODO: NODE_PG_FORCE_NATIVE or NODE_GAUSS_FORCE_NATIVE`
`37`	`38`	`if (typeof process.env.NODE_PG_FORCE_NATIVE !== 'undefined') {`
`38`	`39`	`module.exports = new GAUSSDB(require('./native'))`
`39`	`40`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ for (let i = 0; i < process.argv.length; i++) {`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`
`21`		`-if (process.env['PG_TEST_NATIVE']) {`
	`21`	`+if (process.env['GAUSS_TEST_NATIVE']) {`
`22`	`22`	`config.native = true`
`23`	`23`	`}`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ const suite = new helper.Suite()`
`10`	`10`	`const realEnv = {}`
`11`	`11`	`for (const key in process.env) {`
`12`	`12`	`realEnv[key] = process.env[key]`
`13`		`- if (!key.indexOf('PG')) delete process.env[key]`
	`13`	`+ if (!key.indexOf('GAUSS')) delete process.env[key]`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`suite.test('default values are used in new clients', function () {`