.gitignore

@@ -1,3 +1,4 @@
 node_modules
 tmp
 npm-debug.log
+.vscode

.npmrc

@@ -0,0 +1 @@
+package-lock = false

CONTRIBUTING.md

@@ -1,39 +1,21 @@
 Contributing
 ================================================================================
 
-Awesome!  I'm happy that you want to contribute.
+Awesome!  We're happy that you want to contribute.
 
 Make sure that you're read and understand the [Code of Conduct](CODE_OF_CONDUCT.md).
 
 
 Building from source
 --------------------------------------------------------------------------------
 
-If you want to modify the source to play with it, you'll also want to have the
-`jbuild` program installed.
+The following `npm` scripts are available when doing development on this
+package:
 
-To install `jbuild`, use the command
-
-```text
-npm -g install jbuild
-```
-
-The `jbuild` command runs tasks defined in the `jbuild.coffee` file.  The
-task you will most likely use is `watch`, which you can run with the
-command:
-
-```text
-jbuild watch
-```
-
-When you run this command, the application will be built from source, the server
-started, and tests run.  When you subsequently edit and then save one of the
-source files, the application will be re-built, the server re-started, and the
-tests re-run.  For ever.  Use Ctrl-C to exit the `jbuild watch` loop.
-
-You can run those build, server, and test tasks separately.  Run `jbuild`
-with no arguments to see what tasks are available, along with a short
-description of them.
+* `npm run build` - build the library from the CoffeeScript source
+* `npm run serve` - run a test server
+* `npm test` - run the tests
+* `npm run watch` - watch for source file changes, then `build`, then `test`
 
 
 GitHub usage

README.md

@@ -43,7 +43,9 @@ your application is running in Cloud Foundry.  These include:
 If these aren't set, the `getAppEnv()` API will still return useful values,
 as appropriate.  This means you can use this package in your program and
 it will provide useful values when you're running in Cloud Foundry AND
-when you're running locally.
+when you're running locally.  You can supply local versions of
+`VCAP_SERVICES` and/or `VCAP_APPLICATION` by using the `vcap` and `vcapFile`
+options described below.
 
 
 api
@@ -89,7 +91,19 @@ The `options` parameter is optional, and can contain the following properties:
 
   This option property is ignored if not running locally.
 
-This function returns an object with the following properties:
+* `vcapFile` - provide the same function as the `vcap` option, but instead of
+  setting the option value to an object, you set it to the name of a JSON
+  file, which will be parsed and used as the `vcap` option value is used,
+  as described above.
+
+  When both `vcap` and `vcapFile` options are provided, the values in `vcap`
+  are ignored.
+
+  This option property is ignored if not running locally.
+
+#### return value
+
+The `getAppEnv()` function returns an object with the following properties:
 
 * `app`:      object version of `VCAP_APPLICATION` env var
 * `services`: object version of `VCAP_SERVICES` env var
@@ -311,6 +325,54 @@ When you visit the site, you'll see the output of various cfenv calls.
 changes
 ================================================================================
 
+**1.2.4** - 2021/04/03
+
+- upgrade most dependencies, but not CoffeeScript, since the latest
+  version generates code that can't be run in older versions of node - [pr #50][]
+
+- change to call `yaml.load()` instead of `yaml.safeLoad()` since it's no
+  longer supported, noticed via an error message: - [pr #50][]
+
+  ```
+  Error: Function yaml.safeLoad is removed in js-yaml 4. Use yaml.load instead, which is now safe by default.
+  ```
+
+[pr #50]: https://github.com/cloudfoundry-community/node-cfenv/pull/50
+
+**1.2.3** - 2020/07/24
+
+- remove `.cfignore` file - [commit #02bb92d][]
+
+[commit #02bb92d]: https://github.com/cloudfoundry-community/node-cfenv/commit/02bb92dacf5f59244b188dae11fd2fe732c4940e
+
+**1.2.2** - 2019/03/26
+
+- handle ports package race condition by returning port 3000 - [pr #41][]
+
+[pr #41]: https://github.com/cloudfoundry-community/node-cfenv/pull/41
+
+**1.2.1** - 2019/03/25
+
+- upgrade js-yaml to avoid vulnerability - [pr #39][]
+
+[pr #39]: https://github.com/cloudfoundry-community/node-cfenv/pull/39
+
+**1.2.0** - 2019/02/21
+
+- use vcapFile port value if available - [pr #36][]
+- upgrade underscore from 1.8.x to 1.9.x - [pr #37][]
+- use `random-route:` instead of `${random-word}` in sample manifest - [pr #38][]
+
+[pr #36]: https://github.com/cloudfoundry-community/node-cfenv/pull/36
+[pr #37]: https://github.com/cloudfoundry-community/node-cfenv/pull/37
+[pr #38]: https://github.com/cloudfoundry-community/node-cfenv/pull/38
+
+**1.1.0** - 2018/04/18
+
+- add the `vcapFile` option - [issue #31][]
+
+[issue #31]: https://github.com/cloudfoundry-community/node-cfenv/issues/31
+
 **1.0.4** - 2017/01/13
 
 - fix to getServiceURL() with non-http URLs  - [issue #21][]
@@ -342,6 +404,13 @@ changes
 - initial 1.0.0 release
 
 
+contributing
+================================================================================
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md) doc for more information on
+contributing to this project.
+
+
 license
 ================================================================================
 

jbuild.coffee

@@ -68,8 +68,8 @@ tasks.test = ->
         ui:         "bdd"
         reporter:   "spec"
         slow:       300
-        compilers:  "coffee:coffee-script"
-        require:    "coffee-script/register"
+    #   compilers:  "coffee:coffeescript"
+        require:    "coffeescript/register"
 
     options = for key, val of options
         "--#{key} #{val}"

lib-src/cfenv.coffee

@@ -29,6 +29,8 @@ class AppEnv
       catch
         @isLocal = true
 
+    @_getVcapFromFile(options) if @isLocal
+
     @app      = getApp      @, options
     @services = getServices @, options
 
@@ -38,6 +40,26 @@ class AppEnv
     @urls     = getURLs @, options
     @url      = @urls[0]
 
+  #-----------------------------------------------------------------------------
+  _getVcapFromFile: (options) ->
+    return if not options?.vcapFile
+
+    contents = null
+    try
+      contents = fs.readFileSync options.vcapFile, 'utf8'
+    catch err
+      console.log "error reading vcapFile '#{options.vcapFile}': #{err}; ignoring"
+      return
+
+    vcap = null
+    try
+      vcap = JSON.parse contents
+    catch err
+      console.log "error parsing vcapFile '#{options.vcapFile}': #{err}; ignoring"
+      return
+
+    options.vcap = vcap
+
   #-----------------------------------------------------------------------------
   toJSON: ->
     {@app, @services, @isLocal, @name, @port, @bind, @urls, @url}
@@ -144,12 +166,18 @@ getServices = (appEnv, options) ->
 
 #-------------------------------------------------------------------------------
 getPort = (appEnv) ->
-  portString = process.env.PORT || process.env.CF_INSTANCE_PORT || process.env.VCAP_APP_PORT
+  portString = process.env.PORT || 
+    process.env.CF_INSTANCE_PORT || 
+    process.env.VCAP_APP_PORT || 
+    appEnv?.app?.port
 
   unless portString?
     return 3000 unless appEnv.name?
 
-    portString = "#{ports.getPort appEnv.name}"
+    try
+      portString = "#{ports.getPort appEnv.name}"
+    catch e
+      portString = '3000'
 
   port = parseInt portString, 10
   throwError "invalid PORT value: /#{portString}/" if isNaN port
@@ -165,7 +193,7 @@ getName = (appEnv, options) ->
 
   if fs.existsSync "manifest.yml"
     yString = fs.readFileSync "manifest.yml", "utf8"
-    yObject = yaml.safeLoad yString, filename: "manifest.yml"
+    yObject = yaml.load yString, filename: "manifest.yml"
 
     yObject = yObject.applications[0] if yObject.applications?
     return yObject.name if yObject.name?

manifest.yml

@@ -1,6 +1,6 @@
 applications:
 - name:      cf-env-test
   mem:       128M
-  host:      cf-env-test-${random-word}
+  random-route: true
   services:
   - cf-env-test

package.json

@@ -1,23 +1,30 @@
 {
-    "name":                 "cfenv",
-    "main":                 "./lib/cfenv",
-    "description":          "easy access to your Cloud Foundry application environment",
-    "version":              "1.0.4",
-    "author":               "pmuellr",
-    "license":              "Apache-2.0",
-    "homepage":             "https://github.com/cloudfoundry-community/node-cfenv",
+    "name": "cfenv",
+    "main": "./lib/cfenv",
+    "description": "easy access to your Cloud Foundry application environment",
+    "version": "1.2.4",
+    "author": "pmuellr",
+    "license": "Apache-2.0",
+    "homepage": "https://github.com/cloudfoundry-community/node-cfenv",
     "repository": {
-        "type":             "git",
-        "url":              "https://github.com/cloudfoundry-community/node-cfenv.git"
+        "type": "git",
+        "url": "https://github.com/cloudfoundry-community/node-cfenv.git"
+    },
+    "scripts": {
+        "build": "jbuild build",
+        "serve": "jbuild serve",
+        "test": "jbuild test",
+        "watch": "jbuild watch"
     },
     "dependencies": {
-        "js-yaml":          "3.7.x",
-        "ports":            "1.1.x",
-        "underscore":       "1.8.x"
+        "js-yaml": "4.0.x",
+        "ports": "1.1.x",
+        "underscore": "1.12.x"
     },
     "devDependencies": {
-        "coffee-script":    "1.12.x",
-        "mocha":            "3.2.x",
-        "expect.js":        "0.3.x"
+        "coffeescript": "1.12.x",
+        "expect.js": "0.3.x",
+        "jbuild": "1.0.x",
+        "mocha": "8.3.x"
     }
 }

tests/fixtures/vcap-local-bad.json

@@ -0,0 +1 @@
+this file intentially does not contain valid JSON

tests/fixtures/vcap-local-good.json

@@ -0,0 +1,16 @@
+{
+    "application": {
+        "port": 42
+    },
+    "services": {
+        "service-a-label": [
+            {
+                "name": "service-a",
+                "label": "service-a-label",
+                "credentials": {
+                    "url": "foo"
+                }
+            }
+        ]
+    }
+}