brightpearl-cli 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4270946635291cd6218eecb1db111e4e7f5f80ea
+  data.tar.gz: 99c3dae282a3fa940dd23b908258932bb99fe458
+SHA512:
+  metadata.gz: d171d52f0b475e1f02949a690de03a100d5b36ccc6ef840e273b3f3dfb619e4b832bf2c38bbb99691b626aa774aaf43d46f775e57325e5274d4bac9c61ab1e5b
+  data.tar.gz: 37fdb1baaff906e229daab38e965d324d21d94b9caca37f3b8fa65759e88db0e864550b83ed927a7d8c9c99af6c8e4345d257c589231c926ab0a6f2725e19046

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 - Albert Rannetsperger (Brightpearl)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+brightpearl-cli
+===============
+
+**A command-line utility created for Brightpearl developers and QAs.**
+
+**brightpearl-cli** is a tool used for automating daily work-flows and repetitive tasks within Brightpearl's technical team.
+Its aim is to make the team more efficient by minimizing errors whilst conforming to Brightpearl's high, internal development practices at all times.
+
+The tool is written primarily in Ruby.
+
+CLI stands for Command-line Interface.
+
+### Installation
+
+The gem lives on the RubyGems server so installation is as easy as:
+
+```bash
+gem install columnist
+```
+
+### Usage

data/bin/bp

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'brightpearl_cli'
+
+Brightpearl::execute

data/bin/brightpearl

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'brightpearl_cli'
+
+Brightpearl::execute

data/lib/brightpearl_cli.rb

@@ -0,0 +1,351 @@
+require 'convoy'
+require 'yaml'
+
+require 'core/api'
+require 'core/config'
+require 'core/enums'
+require 'core/git'
+require 'core/jira'
+require 'core/mysql'
+require 'core/terminal'
+require 'core/tools'
+require 'core/validate'
+require 'routes/build'
+require 'routes/dummy_order'
+require 'routes/git_branch'
+require 'routes/git_checkout'
+require 'routes/git_delete'
+require 'routes/git_merge'
+require 'routes/git_pull'
+require 'routes/git_push'
+require 'routes/git_stash'
+require 'routes/git_update'
+require 'routes/jira'
+require 'routes/less'
+require 'routes/reset'
+require 'routes/review'
+require 'routes/scripts_color'
+require 'routes/scripts_code_sniffer'
+require 'routes/setup'
+require 'routes/update'
+require 'routes/tests'
+
+module Brightpearl
+
+    def self.execute
+
+        begin
+
+            unless !ARGV.any? || ARGV[0] == 'setup' || ARGV[0] == 'x'
+                Brightpearl::Config.initialize
+            end
+
+            Convoy::App.create do |brightpearl|
+
+                #  COLOR OF TITLE TEXT
+                title_color = 255
+
+                # TRUE/FALSE DEPENDING ON WHETHER USER IN ON BETA OR NOT.
+                beta_only = Brightpearl::Config.param(Brightpearl::Config::BETA) == 'true' ? true : false
+
+                brightpearl.version '1.1.0'
+                brightpearl.summary "\x1B[38;5;166mBRIGHTPEARL-CLI\x1B[0m \x1B[38;5;240m\xe2\x80\x94 BETA\x1B[0m"
+                brightpearl.description "\x1B[38;5;#{title_color}mA command line utility for Brightpearl developers and QAs.\nUsed for automating daily work flows & completing repetitive tasks quicker with less errors.\nDesigned to work from anywhere on your workstation.\n\nUse #{Brightpearl::Terminal::format_command('brightpearl')}\x1B[38;5;#{title_color}m or #{Brightpearl::Terminal::format_command('bp')}\x1B[38;5;#{title_color}m to run.\x1B[0m"
+
+                if beta_only
+
+                    # BUILD
+                    brightpearl.command :build, :aliases => [:b] do |build|
+                        build.summary 'Build (and deploy) Java services'
+                        build.action do |opts, args|
+                            BrightpearlCommand::Build.new(opts, args).execute
+                        end
+                    end
+
+                    # DUMMY
+                    brightpearl.command :dummy, :aliases => [:d] do |dummy|
+
+                        dummy.summary 'Insert dummy data into the App'
+
+                        # DUMMY ORDER
+                        dummy.command :order, :aliases => [:o] do |dummy_order|
+                            dummy_order.summary 'Create dummy orders'
+                            dummy_order.options do |opts|
+                                opts.opt :salesOrder, 'Create sales order', :short => '-s', :long => '--sales-order', :type => :boolean
+                                opts.opt :salesCredit, 'Create sales credit', :short => '-S', :long => '--sales-credit', :type => :boolean
+                                opts.opt :purchaseOrder, 'Create purchase order', :short => '-p', :long => '--purchase-order', :type => :boolean
+                                opts.opt :purchaseCredit, 'Create purchase credit', :short => '-P', :long => '--purchase-credit', :type => :boolean
+                                opts.opt :times, 'Specify number of orders (maximum 50)', :short => '-x', :long => '--times', :type => :int
+                            end
+                            dummy_order.action do |opts, args|
+                                BrightpearlCommand::DummyOrder.new(opts, args).execute
+                            end
+                        end
+
+                        # CREATE (DEFAULT)
+                        dummy.action do
+                            system('bp d -h')
+                        end
+
+                    end
+
+                end
+
+                # GIT
+
+                brightpearl.command :git, :aliases => [:g] do |git|
+
+                    git.summary 'All git related functionality'
+
+                    # GIT BRANCH
+                    git.command :branch, :aliases => [:b] do |git_branch|
+                        git_branch.summary 'List local/remote branches'
+                        git_branch.options do |opts|
+                            opts.opt :local, 'List local branches', :short => '-l', :long => '--local', :type => :boolean
+                            opts.opt :remote, 'List remote branches', :short => '-r', :long => '--remote', :type => :boolean
+                            opts.opt :sortDate, 'Sort by date', :short => '-d', :long => '--sort-date', :type => :boolean
+                            opts.opt :sortRefname, 'Sort by branch name (default)', :short => '-n', :long => '--sort-refname', :type => :boolean
+                            opts.opt :detailed, 'Show a more detailed output w/Jira data, etc. (takes longer)', :short => '-D', :long => '--detailed', :type => :boolean
+                        end
+                        git_branch.action do |opts, args|
+                            BrightpearlCommand::GitBranch.new(opts, args).execute
+                        end
+                    end
+
+                    # GIT CHECKOUT
+                    git.command :checkout, :aliases => [:c, :co] do |git_checkout|
+                        git_checkout.summary 'Create & checkout branches'
+                        git_checkout.options do |opts|
+                            opts.opt :branch, 'Create a branch locally', :short => '-b', :long => '--branch', :type => :boolean
+                            opts.opt :branch_origin, 'Create a branch and push to origin', :short => '-B', :long => '--branch-origin', :type => :boolean
+                            opts.opt :update, "Update branch after checkout. Will run a 'git pull' & 'git merge master'", :short => '-u', :long => '--update', :type => :boolean
+                            opts.opt :updatePush, 'Same as --update but will also push to origin', :short => '-U', :long => '--update-push', :type => :boolean
+                        end
+                        git_checkout.action do |opts, args|
+                            BrightpearlCommand::GitCheckout.new(opts, args).execute
+                        end
+                    end
+
+                    # GIT DELETE
+                    git.command :delete, :aliases => [:d] do |git_delete|
+                        git_delete.summary 'Delete branch(es)'
+                        git_delete.options do |opts|
+                            opts.opt :delete_local, 'Delete local branch', :short => '-l', :long => '--delete-local', :type => :boolean
+                            opts.opt :delete_remote, 'Delete remote branch', :short => '-r', :long => '--delete-remote', :type => :boolean
+                            opts.opt :delete_both, 'Delete both local & remote branches', :short => '-b', :long => '--delete-both', :type => :boolean
+                        end
+                        git_delete.action do |opts, args|
+                            BrightpearlCommand::GitDelete.new(opts, args).execute
+                        end
+                    end
+
+                    # GIT MERGE
+                    git.command :merge, :aliases => [:m] do |git_merge|
+                        git_merge.summary 'Merge branch(es)'
+                        d = "Accepts one #{Brightpearl::Terminal::format_action('mandatory')} primary argument \xe2\x80\x94 the name of the source branch."
+                        d << "\nAccepts one #{Brightpearl::Terminal::format_action('optional')} secondary argument \xe2\x80\x94 the name of the target branch."
+                        d << "\n"
+                        d << "\nIf no secondary argument is given, target branch will be #{Brightpearl::Terminal::format_branch('current-branch')}"
+                        d << "\n"
+                        d << "\n    #{Brightpearl::Terminal::format_command('bp g m')} #{Brightpearl::Terminal::format_command('source_branch')} \x1B[0m"
+                        d << "\n    #{Brightpearl::Terminal::format_command('bp g m')} #{Brightpearl::Terminal::format_command('source_branch target_branch')} \x1B[0m"
+                        d << "\n"
+                        d << "\nTo merge multiple branches at once, use comma-separated string (w/out spaces) :"
+                        d << "\n"
+                        d << "\n    #{Brightpearl::Terminal::format_command('bp g m')} #{Brightpearl::Terminal::format_command('sb1,sb2,sb3')}"
+                        d << "\n    #{Brightpearl::Terminal::format_command('bp g m')} #{Brightpearl::Terminal::format_command('sb1,sb2,sb3 target_branch')}"
+                        d << "\n"
+                        d << "\nAlternatively, use the #{Brightpearl::Terminal::format_flag('f')} and specify a filename like so:"
+                        d << "\n"
+                        d << "\n\x1B[38;5;240m 1) Create a .txt file (IE: '/tmp/merge.txt') with names of branches you'd like to merge on separate lines."
+                        d << "\n\x1B[38;5;240m 2) Pass the file as a parameter to the script."
+                        d << "\n"
+                        d << "\n    #{Brightpearl::Terminal::format_command('bp g m')} #{Brightpearl::Terminal::format_command('-f /tmp/merge.txt')} \x1B[0m"
+                        d << "\n    #{Brightpearl::Terminal::format_command('bp g m')} #{Brightpearl::Terminal::format_command('-f /tmp/merge.txt target_branch')} \x1B[0m"
+                        git_merge.description d
+                        git_merge.options do |opts|
+                            opts.opt :from_file, 'Get branch names from file (1 branch per line)', :short => '-f', :long => '--from-file', :type => :string
+                        end
+                        git_merge.action do |opts, args|
+                            BrightpearlCommand::GitMerge.new(opts, args).execute
+                        end
+                    end
+
+                    if beta_only
+
+                        # GIT PULL
+                        git.command :pull, :aliases => [:p] do |git_pull|
+                            git_pull.summary 'Pull from origin'
+                            git_pull.action do |opts, args|
+                                BrightpearlCommand::GitPull.new(opts, args).execute
+                            end
+                        end
+
+                        # GIT PUSH
+                        git.command :push, :aliases => [:P] do |git_push|
+                            git_push.summary 'Push to origin'
+                            git_push.action do |opts, args|
+                                BrightpearlCommand::GitPush.new(opts, args).execute
+                            end
+                        end
+
+                        # GIT STASH
+                        git.command :stash, :aliases => [:S] do |git_stash|
+                            git_stash.summary 'Stash/un-stash your changes'
+                            git_stash.action do |opts, args|
+                                BrightpearlCommand::GitStash.new(opts, args).execute
+                            end
+                        end
+
+                    end
+
+                    # GIT UPDATE
+                    git.command :update, :aliases => [:u] do |git_update|
+                        git_update.summary 'Update branch(es)'
+                        git_update.options do |opts|
+                            opts.opt :all, 'Update all local branches', :short => '-a', :long => '--all', :type => :boolean
+                            opts.opt :push, 'Push updates to origin', :short => '-P', :long => '--push', :type => :boolean
+                        end
+                        git_update.action do |opts, args|
+                            BrightpearlCommand::GitUpdate.new(opts, args).execute
+                        end
+                    end
+
+                    # GIT (DEFAULT)
+                    git.action do
+                        system('bp g -h')
+                    end
+
+                end
+
+                if beta_only
+
+                    # JIRA
+                    brightpearl.command :jira, :aliases => [:j] do |jira|
+                        jira.summary 'Access the Jira API'
+
+                        # JIRA CARD
+                        jira.command :card, :aliases => [:c] do |jira_card|
+                            jira_card.summary 'Get detailed information about a card'
+                            jira_card.action do |opts, args|
+                                BrightpearlCommand::JiraCard.new(opts, args).execute
+                            end
+                        end
+
+                        # JIRA (DEFAULT)
+                        jira.action do
+                            system('bp j -h')
+                        end
+                    end
+
+                end
+
+                # LESS
+                brightpearl.command :less, :aliases => [:l] do |less|
+                    less.summary "Compile #{Brightpearl::Terminal::format_directory('screen.less')} file"
+                    less.options do |opts|
+                        opts.opt :skipConfirm, 'Skips confirmation. Will compile less file immediately', :short => '-K', :long => '--skip-confirmation', :type => :boolean
+                    end
+                    less.action do |opts, args|
+                        BrightpearlCommand::Less.new(opts, args).execute
+                    end
+                end
+
+                if beta_only
+
+                    # RESET
+                    brightpearl.command :reset, :aliases => [:R] do |reset|
+                        reset.summary 'Reset various things within the App'
+                        reset.options do |opts|
+                            opts.opt :fitnesseDump, 'Reset the Fitnesse Dump on your VM', :short => '-f', :long => '--fitnesse-dump', :type => :boolean
+                        end
+                        reset.action do |opts, args|
+                            BrightpearlCommand::Reset.new(opts, args).execute
+                        end
+                    end
+
+                end
+
+                # REVIEW
+                brightpearl.command :review, :aliases => [:r] do |review|
+                    review.summary 'Perform a quick code review'
+                    review.action do |opts, args|
+                        BrightpearlCommand::Review.new(opts, args).execute
+                    end
+                end
+
+                # SCRIPTS
+                brightpearl.command :scripts, :aliases => [:s] do |scripts|
+
+                    scripts.summary 'Quick & dirty scripts'
+
+                    # SCRIPTS COLOR
+                    scripts.command :color, :aliases => [:c] do |scripts_color|
+                        scripts_color.summary 'Shows a list of bash/ruby color codes (256-bit)'
+                        scripts_color.action do |opts, args|
+                            BrightpearlCommand::ScriptsColor.new(opts, args).execute
+                        end
+                    end
+
+                    # SCRIPTS PHP CODE-SNIFFER
+                    scripts.command :sniff, :aliases => [:s] do |code_sniffer|
+                        code_sniffer.summary 'Run PHP CodeSniffer'
+                        code_sniffer.action do |opts, args|
+                            BrightpearlCommand::ScriptsCodeSniffer.new(opts, args).execute
+                        end
+                    end
+
+                    # SCRIPTS (DEFAULT)
+                    scripts.action do
+                        system('bp s -h')
+                    end
+
+                end
+
+                # TEST
+                brightpearl.command :tests, :aliases => [:t] do |test|
+                    test.summary 'Run various tests (PHPUnit by default)'
+                    test.options do |opts|
+                        opts.opt :cucumber, 'Run Cucumber tests', :short => '-c', :long => '--cucumber', :type => :boolean
+                        opts.opt :fitnesse, 'Run FitNesse tests', :short => '-f', :long => '--fitnesse', :type => :boolean
+                        opts.opt :php, 'Run PHPUnit tests (default)', :short => '-p', :long => '--php-unit', :type => :boolean
+                        opts.opt :ruby, 'Run Ruby UI tests', :short => '-r', :long => '--ruby-ui', :type => :boolean
+                    end
+                    test.action do |opts, args|
+                        BrightpearlCommand::Test.new(opts, args).execute
+                    end
+                end
+
+                # UPDATE
+                brightpearl.command :update, :aliases => [:u] do |update|
+                    update.summary 'Check for updates'
+                    update.action do |opts, args|
+                        BrightpearlCommand::Update.new(opts, args).execute
+                    end
+                end
+
+                # X - SETUP
+                brightpearl.command :setup, :aliases => [:x] do |setup|
+                    setup.summary 'Setup your configuration file'
+                    setup.action do |opts, args|
+                        BrightpearlCommand::Setup.new(opts, args).execute
+                    end
+                end
+
+                # BRIGHTPEARL/BP (DEFAULT)
+                brightpearl.action do
+                    system('bp -h')
+                end
+
+            end
+
+        rescue RuntimeError => e
+
+            puts e.message
+            puts e.backtrace
+
+        end
+
+    end
+
+end

data/lib/core/api.rb

@@ -0,0 +1,7 @@
+module Brightpearl
+
+    class API
+
+    end
+
+end

data/lib/core/config.rb

@@ -0,0 +1,175 @@
+require 'fileutils'
+require 'parseconfig'
+
+module Brightpearl
+
+    class Config
+
+        CONFIG_FILE = '~/.brightpearlrc'
+
+        BETA = 'beta'
+        MAC = 'mac'
+        LINUX = 'linux'
+
+        WORKSTATION_IP = 'workstation_ip'
+        WORKSTATION_OS = 'workstation_os'
+        WORKSTATION_PATH_TO_BP_CODE = 'workstation_path_to_bp_code'
+        WORKSTATION_PATH_TO_BP_DB = 'workstation_path_to_bp_db'
+        VM_IP = 'vm_ip'
+        VM_USER = 'vm_user'
+        VM_USER_PASSWORD = 'vm_user_password'
+        VM_ROOT = 'vm_root'
+        VM_ROOT_PASSWORD = 'vm_root_password'
+        VM_MYSQL_USER = 'vm_mysql_user'
+        VM_MYSQL_PASSWORD = 'vm_mysql_password'
+
+        @params = {}
+
+        def self.param(param_name)
+            unless required_config_keys.include?(param_name) || param_name == BETA
+                raise RuntimeError, "'#{param_name}' is not a valid config parameter."
+            end
+            @params[param_name]
+        end
+
+        def self.initialize
+            if config_file_exists?
+                run_load_config
+            else
+                run_first_journey
+            end
+        end
+
+        def self.config_file_exists?
+            unless File.exists? ("#{File.expand_path(CONFIG_FILE)}")
+                return false
+            end
+            true
+        end
+
+        def self.run_load_config
+            config_params_get
+            config_params_validate
+        end
+
+        def self.run_first_journey
+            first_journey_message
+            config_file_create
+            config_file_edit
+            config_params_get
+            config_params_validate(true)
+        end
+
+        def self.first_journey_message
+            puts
+            puts "Thank you for installing the \x1B[36mbrightpearl-cli\x1B[0m ruby gem."
+            puts "CLI stands for 'Command Line Interface'."
+            puts
+            puts 'The first thing you will need to do is setup your configuration file.'
+            puts "This file will always be located at: \x1B[33m~/.brightpearlrc\x1B[0m"
+            puts
+            puts "You probably won't have this file but this program will create it for you."
+            puts 'The next screen will open a nano text editor where you can set it up.'
+            Brightpearl::Terminal::enter_to_continue
+        end
+
+        def self.config_file_create
+            File.open("#{File.expand_path(CONFIG_FILE)}", 'w') { |file|
+                file.write("# CONFIGURATION FILE -- Make sure that ALL parameters are correct before saving.\n")
+                file.write("\n")
+                file.write("#{WORKSTATION_IP}=172.27.X.X\n")
+                file.write("#{WORKSTATION_OS}=linux\n")
+                file.write("#{WORKSTATION_PATH_TO_BP_CODE}=/brightpearl-source/brightpearl-code\n")
+                file.write("#{WORKSTATION_PATH_TO_BP_DB}=/brightpearl-source/brightpearl-db\n")
+                file.write("\n")
+                file.write("#{VM_IP}=172.27.X.X\n")
+                file.write("#{VM_USER}=\n")
+                file.write("#{VM_USER_PASSWORD}=\n")
+                file.write("#{VM_ROOT}=root\n")
+                file.write("#{VM_ROOT_PASSWORD}=peXXXXXXXre\n")
+                file.write("#{VM_MYSQL_USER}=root\n")
+                file.write("#{VM_MYSQL_PASSWORD}=peXXXXXXXre\n")
+            }
+        end
+
+        def self.config_file_edit
+            system("nano #{File.expand_path(CONFIG_FILE)}")
+        end
+
+        def self.config_params_get
+            config = ParseConfig.new("#{File.expand_path(CONFIG_FILE)}")
+            config.get_params.each do |param|
+                @params[param] = config[param]
+            end
+        end
+
+        def self.config_params_validate(show_success_message = false)
+            error_text = ''
+            missing_keys = get_missing_config_keys
+            if missing_keys.any?
+                missing_keys.each do |key|
+                    error_text = "#{error_text}\x1B[38;5;196mKey/value must exist and cannot be null:\x1B[0m \x1B[38;5;240m#{key}\x1B[0m\n"
+                end
+                error_text = error_text[0..-2]
+            end
+            workstation_os = Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_OS)
+            unless workstation_os.downcase == MAC || workstation_os.downcase == LINUX
+                unless error_text == ''
+                    error_text = "#{error_text}\n\n"
+                end
+                error_text = "#{error_text}\x1B[38;5;196mThe value for \x1B[38;5;240m#{WORKSTATION_OS}\x1B[38;5;196m must be either: \x1B[38;5;84m#{MAC}\x1B[38;5;196m or \x1B[38;5;84m#{LINUX}\x1B[38;5;196m\x1B[0m\n"
+            end
+            unless error_text == ''
+                show_error_message(error_text)
+            end
+            code_repo = Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_PATH_TO_BP_CODE)
+            unless File.directory?(code_repo)
+                error_text = "#{error_text}The following is NOT a valid directory: \x1B[0m#{code_repo}\x1B[90m\n"
+            end
+            unless File.directory?(Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_PATH_TO_BP_DB))
+                error_text = "#{error_text}The following is NOT a valid directory: \x1B[0m#{Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_PATH_TO_BP_DB)}\x1B[90m\n"
+            end
+            unless error_text == ''
+                show_error_message(error_text)
+            end
+            if show_success_message
+                Brightpearl::Terminal::success('Configuration parameters are correct.', "You are now ready to start using this utility.\nStart by typing #{Brightpearl::Terminal::format_command('brightpearl --help')} (or #{Brightpearl::Terminal::format_command('bp -h')}).")
+                exit
+            end
+        end
+
+        def self.show_error_message(error_text)
+            Brightpearl::Terminal::error('Your configuration parameters are invalid.', "#{error_text}\nYou can fix this by running #{Brightpearl::Terminal::format_command('brightpearl setup')} (or #{Brightpearl::Terminal::format_command('bp x')}).")
+            exit
+        end
+
+        def self.get_missing_config_keys
+            missing_keys = required_config_keys.dup
+            @params.each do |key, value|
+                unless value == ''
+                    missing_keys.delete(key)
+                end
+            end
+            missing_keys
+        end
+
+        def self.required_config_keys
+            [
+                WORKSTATION_IP,
+                WORKSTATION_OS,
+                WORKSTATION_PATH_TO_BP_CODE,
+                WORKSTATION_PATH_TO_BP_DB,
+                VM_IP,
+                VM_USER,
+                VM_USER_PASSWORD,
+                VM_ROOT,
+                VM_ROOT_PASSWORD,
+                VM_MYSQL_USER,
+                VM_MYSQL_PASSWORD
+            ]
+        end
+
+    end
+
+
+end

data/lib/core/enums.rb

@@ -0,0 +1,9 @@
+module Brightpearl
+
+    class Enum
+
+        PORT_ORDER_SERVICE = '9240'
+
+    end
+
+end