# node-formula **Repository Path**: saltstack-formulas/node-formula ## Basic Information - **Project Name**: node-formula - **Description**: No description available - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-11-13 - **Last Updated**: 2024-06-02 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README node-formula ============ |img_travis| |img_sr| .. |img_travis| image:: https://travis-ci.com/saltstack-formulas/node-formula.svg?branch=master :alt: Travis CI Build Status :scale: 100% :target: https://travis-ci.com/saltstack-formulas/node-formula .. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg :alt: Semantic Release :scale: 100% :target: https://github.com/semantic-release/semantic-release Formula to install Node.js on GNU/Linux, MacOS, and BSD. The default method is package. See pillar.example file for other ideas. .. contents:: **Table of Contents** :depth: 1 General notes ------------- See the full `SaltStack Formulas installation and usage instructions `_. If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section `_. If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``, which contains the currently released version. This formula is versioned according to `Semantic Versioning `_. See `Formula Versioning Section `_ for more details. If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section. Contributing to this repo ------------------------- **Commit message formatting is significant!!** Please see `How to contribute `_ for more details. Special notes ------------- None. Available states ---------------- .. contents:: :local: ``node`` ^^^^^^^^ *Meta-state (This is a state that includes other states)*. This installs Node package, manages Node configuration file and then starts the associated node service. ``node.package`` ^^^^^^^^^^^^^^^^ This state will install Node package only. ``node.archive`` ^^^^^^^^^^^^^^^^ This state will install Node from archive only. ``node.source`` ^^^^^^^^^^^^^^^ This state will install Node from source only. ``node.config`` ^^^^^^^^^^^^^^^ This state will configure npmrc and/or environment and has a dependency on ``node.install`` via include list. ``node.clean`` ^^^^^^^^^^^^^^ *Meta-state (This is a state that includes other states)*. this state will undo everything performed in the ``node`` meta-state in reverse order, i.e. removes the configuration file and then uninstalls the package. ``node.config.clean`` ^^^^^^^^^^^^^^^^^^^^^ This state will remove the configuration of Node and has a dependency on ``node.package.clean`` via include list. ``node.package.clean`` ^^^^^^^^^^^^^^^^^^^^^^ This state will remove Node package and has a dependency on ``node.config.clean`` via include list. ``node.source.clean`` ^^^^^^^^^^^^^^^^^^^^^ This state will remove Node package and has a dependency on ``node.config.clean`` via include list. ``node.archive.clean`` ^^^^^^^^^^^^^^^^^^^^^^ This state will remove Node package and has a dependency on ``node.config.clean`` via include list. Testing ------- Linux testing is done with ``kitchen-salt``. Requirements ^^^^^^^^^^^^ * Ruby * Docker .. code-block:: bash $ gem install bundler $ bundle install $ bin/kitchen test [platform] Where ``[platform]`` is the platform name defined in ``kitchen.yml``, e.g. ``debian-9-2019-2-py3``. ``bin/kitchen converge`` ^^^^^^^^^^^^^^^^^^^^^^^^ Creates the docker instance and runs the ``node`` main state, ready for testing. ``bin/kitchen verify`` ^^^^^^^^^^^^^^^^^^^^^^ Runs the ``inspec`` tests on the actual instance. ``bin/kitchen destroy`` ^^^^^^^^^^^^^^^^^^^^^^^ Removes the docker instance. ``bin/kitchen test`` ^^^^^^^^^^^^^^^^^^^^ Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. ``bin/kitchen login`` ^^^^^^^^^^^^^^^^^^^^^ Gives you SSH access to the instance for manual testing. Testing with Vagrant -------------------- Windows/FreeBSD/OpenBSD testing is done with ``kitchen-salt``. Requirements ^^^^^^^^^^^^ * Ruby * Virtualbox * Vagrant Setup ^^^^^ .. code-block:: bash $ gem install bundler $ bundle install --with=vagrant $ bin/kitchen test [platform] Where ``[platform]`` is the platform name defined in ``kitchen.vagrant.yml``, e.g. ``windows-81-latest-py3``. Note ^^^^ When testing using Vagrant you must set the environment variable ``KITCHEN_LOCAL_YAML`` to ``kitchen.vagrant.yml``. For example: .. code-block:: bash $ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test # Alternatively, $ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml $ bin/kitchen test Then run the following commands as needed. ``bin/kitchen converge`` ^^^^^^^^^^^^^^^^^^^^^^^^ Creates the Vagrant instance and runs the ``vault`` main states, ready for testing. ``bin/kitchen verify`` ^^^^^^^^^^^^^^^^^^^^^^ Runs the ``inspec`` tests on the actual instance. ``bin/kitchen destroy`` ^^^^^^^^^^^^^^^^^^^^^^^ Removes the Vagrant instance. ``bin/kitchen test`` ^^^^^^^^^^^^^^^^^^^^ Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. ``bin/kitchen login`` ^^^^^^^^^^^^^^^^^^^^^ Gives you RDP/SSH access to the instance for manual testing.