RubyGems - MuranoCLI - Versions diffs - 3.2.1.pre.beta.6 → 3.2.1.pre.beta.7 - Mend

MuranoCLI 3.2.1.pre.beta.6 → 3.2.1.pre.beta.7

Files changed (228) hide show

data/dockers/RELEASE.rst DELETED Viewed

@@ -1,135 +0,0 @@
-###################################
-MURANO CLI GEM RELEASE INSTRUCTIONS
-###################################
-(lb): It'd be nice to script this. But for now, copy-paste!
-###########################
-One-time Setup Instructions
-###########################
-Sign Up for RubyGems Account
-----------------------------
-- Sign up for account and request access to Murano CLI gem.
-  https://rubygems.org/
-- Murano CLI RubyGems.org Repo
-  https://rubygems.org/gems/MuranoCLI
-Checkout Murano CLI locally
----------------------------
-E.g., this is how (lb) does it::
-  MURCLI_BASE=/exo/clients/exosite/MuranoCLIs
-  mkdir -p ${MURCLI_BASE}
-  cd ${MURCLI_BASE}
-  git clone git@github.com:exosite/MuranoCLI.git exosite+MuranoCLI
-###################################
-Copy-paste Gem Release Instructions
-###################################
-Set that latest version
------------------------
-Set the release version, e.g.,::
-  MURCLI_VER="3.2.0.beta.8"
-  MURCLI_REL="v${MURCLI_VER}"
-Choose a release: pre or official
----------------------------------
-Official Gem Release::
-  MURCLI_REF="master"
-Beta/Pre-release Gem Release::
-  MURCLI_REF="develop"
-Trigger the Gem release build
------------------------------
-Set the variables above, and then tag the appropriate branch::
-  cd ${MURCLI_BASE}/exosite+MuranoCLI
-  git checkout ${MURCLI_REF}
-  git pull --ff-only
-  git tag -a "${MURCLI_REL}" -m "Release tag: ${MURCLI_REL}" ${MURCLI_REF}
-  git push origin "${MURCLI_REL}"
-Wait for the build to start
----------------------------
-The Jenkins build server is on a five minute poll. You can either
-start the build yourself, or you can wait for it to start.
-- Jenkins server URL
-  https://jenkins.exosite.com/job/MuranoCLI/job/Murano%20CLI%20Gem%20Release/
-Download the built Gem and publish it
--------------------------------------
-Create a GitHub token and store in an environ::
-  GITHUB_TOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
-Download the built Gem from GitHub::
-  mkdir -p /tmp/gem_push
-  pushd /tmp/gem_push
-  OWNER="exosite"
-  REPO="MuranoCLI"
-  #
-  curl --header "Authorization: token ${GITHUB_TOKEN}" \
-       --header "Accept: application/json" \
-       --remote-name \
-       --location https://api.github.com/repos/${OWNER}/${REPO}/releases
-  cat releases
-  #
-  curl --header "Authorization: token ${GITHUB_TOKEN}" \
-       --header "Accept: application/json" \
-       --remote-name \
-       --location \
-         https://api.github.com/repos/${OWNER}/${REPO}/releases/tags/v${MURCLI_VER}
-  cat v${MURCLI_VER}
-  #
-  ASSET_ID=$(cat v${MURCLI_VER} | jq '.assets[0].id')
-  echo ${ASSET_ID}
-  #
-  wget \
-    -q \
-    --auth-no-challenge \
-    --header='Accept:application/octet-stream' \
-    https://${GITHUB_TOKEN}:@api.github.com/repos/${OWNER}/${REPO}/releases/assets/${ASSET_ID} \
-    -O MuranoCLI-${MURCLI_VER}.gem
-  ls -la MuranoCLI-${MURCLI_VER}.gem
-Publish the gem::
-  gem push MuranoCLI-${MURCLI_VER}.gem
-  popd
-  rm /tmp/gem_push/MuranoCLI-${MURCLI_VER}.gem
-  rm /tmp/gem_push/v${MURCLI_VER}
-  rm /tmp/gem_push/releases
-  rmdir /tmp/gem_push
-Test!::
-  gem uninstall MuranoCLI
-  murano -v
-  gem install MuranoCLI
-  murano -v
-  gem install MuranoCLI --pre
-  murano -v

data/dockers/docker-test.sh DELETED Viewed

@@ -1,163 +0,0 @@
-#!/bin/bash
-# This script is called by the Jenkins Build step Execute Shell command,
-# via `docker exec`.
-#
-# This script is run in a Docker container as user 'jenkins'. If Dockerfile
-# did not set up the user first, you'd permissions issues, and you'd see
-# weird behavior, such as:
-#
-#   $ whoami
-#   sudo: unknown uid 1001: who are you?
-#   $ sudo whoami
-#   whoami: cannot find name for user ID 1001
-#   whoami:
-#   $ echo ${USER}
-#   jenkins
-#   $ users
-#   $ groups
-#   cannot find name for group ID 1001
-#   1001
-#
-# To work around this, the Dockerfile calls `useradd ... jenkins`,
-# and the Jenkins Build Environment "User group" is set to 'root'.
-# (This
-# Jenkins runs the Build step Execute Shell command from the
-# ${WORKSPACE} directory, e.g.,
-#
-#   /tmp/jenkins-ff750fb5/workspace/MuranoCLI/MrMurano Tests
-#
-# which is actually outside the Docker container (on the host).
-#
-# We use the advanced Docker option, Volumes, to wire our container to
-# the host. Specifically, Dockerfile wires /app/report and /app/coverage
-# to ${WORKSPACE}/report and ${WORKSPACE}/coverage, respectively.
-# The Dockerfile uses ENV to change the encoding from ASCII, which
-# we cannot do from within the container. You should see UTF-8.
-#
-#   $ echo ${LANG}
-#   en_US.UTF-8
-# Jenkins sets a few environs, like ${WORKSPACE}, and we pull in a few
-# more from the Jenkins Environment Injector Plugin.
-must_verify_environs () {
-  [[ -z ${WORKSPACE} ]] && echo "ERROR: Expected WORKSPACE to be set" && exit 1
-  [[ -z ${MURANO_USERNAME} ]] && echo "ERROR: Please set MURANO_USERNAME" && exit 1
-  [[ -z ${MURANO_PASSWORD} ]] && echo "ERROR: Please set MURANO_PASSWORD" && exit 1
-  [[ -z ${MURANO_BUSINESS} ]] && echo "ERROR: Please set MURANO_BUSINESS" && exit 1
-  # TEST_ME: (lb): I bet WORKSPACE is set to /app on Docker.
-  if [[ -d /app && "${WORKSPACE}" != "/app" ]]; then
-    echo "WARNING: WORKSPACE not /app?: ${WORKSPACE}"
-  fi
-}
-# Create a basic Murano CLI config indicating the Murano account credentials.
-# Default to host "bizapi-staging.hosted.exosite.io".
-export MURANO_BIZAPIIO=${MURANO_BIZAPIIO:-bizapi-staging.hosted.exosite.io}
-export MURANO_CONFIGFILE="${MURANO_CONFIGFILE:-${WORKSPACE}/test.run.muranocfg}"
-create_basic_config () {
-  cat > "${MURANO_CONFIGFILE}" <<-EOCFB
-[user]
-  name = ${MURANO_USERNAME}
-[business]
-  id = ${MURANO_BUSINESS}
-[net]
-  host = ${MURANO_BIZAPIIO}
-EOCFB
-}
-remove_basic_config () {
-  rm "${MURANO_CONFIGFILE}"
-}
-# Switch to the project directory and run tests.
-prepare_to_test () {
-  cd ${WORKSPACE}
-  # Instead of `rake test_clean_up -t`, call CLI directly with --no-color.
-  echo "Removing existing solutions from Murano account."
-  # We're not installing Murano CLI using gem, so we have to tell ruby
-  # where the library is.
-  export murano="ruby -I${WORKSPACE}/lib ${WORKSPACE}/bin/murano"
-  ${murano} solutions expunge -y --no-progress --no-color --ascii
-  # Fix the PATH to avoid the error (on new Jenkins, dockerized test server):
-  #
-  #   /tmp/jenkins8459777890102160498.sh: line 81: rspec: command not found
-  PATH=${PATH}:/usr/local/bundle/bin
-  # (lb): Sometimes the host drive directories mount as root:root with 2755
-  # permissions. But sometimes not. If it starts happening again, you'll see
-  # Errno::EACCES: Permission denied. Uncomment the sudoers code in Dockerfile.
-  if [[ -d /app ]]; then
-    sudo chmod 2777 /app/report
-    sudo chmod 2777 /app/coverage
-  else
-    mkdir ${WORKSPACE}/report
-    mkdir ${WORKSPACE}/coverage
-  fi
-}
-execute_tests () {
-  cd ${WORKSPACE}
-  echo "############################################################################################"
-  echo "Testing \"$(${murano} -v)\" on \"$(ruby -v)\""
-  echo "############################################################################################"
-  # Hint: Add `--example "<...>"` to limit the test suite.
-  set +e
-  local rspec_rsp
-  rspec \
-    --format html \
-    --out ${WORKSPACE}/report/index-${RVERS}.html \
-    --format documentation \
-    "${@}"
-  rspec_rsp=$?
-  local retries=3
-  # BizAPI oftentimes timesout on a few tests, so try again.
-  while [[ ${rspec_rsp} -ne 0 && ${retries} -gt 0 ]]; do
-    echo -e "\n\nRetrying! ${retries} remain!!\n\n"
-    rspec \
-      --format html \
-      --out ${WORKSPACE}/report/index-${RVERS}.html \
-      --format documentation \
-      --only-failures \
-      "${@}"
-    rspec_rsp=$?
-    retries=$((${retries} - 1))
-  done
-  #exit ${rspec_rsp}
-  echo -e "Thanks for flying the Murano CLIs!\n"
-}
-main () {
-  must_verify_environs
-  create_basic_config
-  prepare_to_test
-  execute_tests "${@}"
-  remove_basic_config
-}
-main "${@}"

data/dockers/gem-release.sh DELETED Viewed

@@ -1,4 +0,0 @@
-#!/bin/bash
-ruby -v
-rake build push:github:gem push:github:copyReleaseNotes

data/docs/basic_example.rst DELETED Viewed

@@ -1,436 +0,0 @@
-#######################
-Basic MuranoCLI Example
-#######################
-Learn Murano the Easy Way
-=========================
-This document illustrates how to setup a very basic Murano project.
-It shows how to use the Murano CLI tool (also called "MuranoCLI", or
-just "MurCLI") to create an Application and Product, and how to send
-data to the Product that gets processed by the Application.
-Prerequisites
-=============
-It is assumed that you have already created a Murano business account,
-and that you have installed MurCLI on your local machine.
-- To sign up for a free Murano business account, visit:
-  https://exosite.com/signup/
-- To install MurCLI, run:
-  ``gem install MuranoCLI``
-If you need installation help, look at the `README
-<https://github.com/exosite/MuranoCLI#install>`__.
-Start Fresh
-===========
-You can skip this section if you've never setup a business before.
-But if you've already created a business, and if you've already
-created an Application and/or Product for it, you can clean up
-that business so we can start over.
-First, list your businesses and find the one you want to reset. E.g.,
-.. code-block:: text
-    $ murano business list
-    +------------------+-------+-------------------+
-    | bizid            | role  | name              |
-    +------------------+-------+-------------------+
-    | 4o54fc55olth85mi | owner | My First Business |
-    | fu5rse4xdww2ke29 | admin | Collaborative Biz |
-    | ct7rmoz3hu34ygb9 | owner | Another of My Biz |
-    +------------------+-------+-------------------+
-NOTE: If you have never used MurCLI before, or if you've logged out
-of Murano, MurCLI will tell you to logon first. E.g.,
-.. code-block:: text
-    $ murano business list
-    No Murano user account found.
-    Please login using `murano login` or `murano init`.
-    Or set your password with `murano password set <username>`.
-Next, remove all solutions (Applications and Products) from that project.
-.. code-block:: text
-    $ murano solutions expunge -y -c business.id=ct7rmoz3hu34ygb9
-    Deleted 2 solutions
-Logout of Murano. This removes your username and password so
-that MurCLI will ask you to reenter your username and password.
-.. code-block:: text
-    $ murano logout
-You might also have environment variables set. Clear those for
-the sake of this walk-through.
-.. code-block:: text
-    $ export MURANO_CONFIGFILE=
-    $ export MURANO_PASSWORD=
-Create a New Project
-====================
-Create a new directory for your project.
-.. code-block:: text
-    $ mkdir ~/murano/projects/basic_test
-    $ cd ~/murano/projects/basic_test
-You can run MurCLI commands now, but they won't be useful until you ``init``. E.g.,
-.. code-block:: text
-    $ murano show
-    No Murano user account found.
-    Please login using `murano login` or `murano init`.
-    Or set your password with `murano password set <username>`.
-Run the init command to easily wire the new project to your existing business,
-to create an Application and Product, and to setup local directories and files.
-The init command will link the Product to the Application so that data sent
-to the Product is passed along to the Application.
-Here's an example use of the init command.
-.. code-block:: text
-    $ murano init
-    Creating project at /user/home/murano/projects/basic_test
-    No Murano user account found. Please login.
-    User name: exositement@exosite.com
-    Password: *************
-    1. My First Business  2. Collaborative Biz  3. Another of My Biz
-    Please select the Business to use:
-    3
-    This business does not have any applications. Let's create one
-    Please enter the Application name: basicexample
-    Created new Application: basicexample <v3sl941hifticggc0>
-    This business does not have any products. Let's create one
-    Please enter the Product name: exampleprod
-    Created new Product: exampleprod <n51cq3fea5zc40cs4>
-    Linked ‘exampleprod’ to ‘basicexample’
-    Created default event handler
-    Writing Project file to basictest.murano
-    Created default directories
-    Synced 4 items
-    Success!
-             Business ID: ct7rmoz3hu34ygb9
-          Application ID: v3sl941hifticggc0
-              Product ID: n51cq3fea5zc40cs4
-You'll notice that ``init`` downloaded a few files from Murano that are
-automatically created when you create solutions and link them.
-For instance, you should see a handful of Lua scripts in the ``services``
-directory.
-.. code-block:: text
-    $ ls services
-    n51cq3fea5zc40cs4_event.lua  timer_timer.lua  tsdb_exportJob.lua  user_account.lua
-Update the Data Event Handler
-=============================
-Let's edit the Product data event handler so that it spits out a log message
-when it gets data from the Product. The event handler is named using the
-Product ID, so grab that, and use the ID to make the name of the Lua script.
-.. code-block:: text
-    $ PRODUCT_ID=$(murano config product.id)
-    $ PROD_EVENT="services/${PRODUCT_ID}_event.lua"
-    $ echo ${PROD_EVENT}
-    services/n51cq3fea5zc40cs4_event.lua
-You'll notice that Murano already created a simple event handler.
-.. code-block:: text
-    $ cat ${PROD_EVENT}
-    --#EVENT n51cq3fea5zc40cs4 event
-    print(event)
-Now, overwrite the event handler with something similar. We just
-want to show how easy it is to update the event handler.
-.. code-block:: text
-    $ cat > ${PROD_EVENT} << EOF
-    --#EVENT ${PRODUCT_ID} event
-    print("EVENT: " .. to_json(event))
-    EOF
-NOTE: The ``--#EVENT`` header is mandatory. It tells Murano
-how to interpret the snippet of Lua code.
-If you run the ``status`` command, you should see that there's now one
-file modified locally (the event handler that we just edited) that is
-not synced with the corresponding event handler on Murano.
-.. code-block:: text
-    $ murano status
-    Nothing new locally
-    Nothing new remotely
-    Items that differ:
-     M E  services/n51cq3fea5zc40cs4_event.lua
-Run the ``syncup`` command to upload any modified files to Murano,
-overwriting what is on Murano.
-.. code-block:: text
-    $ murano syncup
-Create and Provision a New Device
-=================================
-In order to do something useful, we need to create a device,
-that is attached to the Product, that can generate data.
-You'll notice that the new Product does not have any devices.
-.. code-block:: text
-    $ murano device list
-    Did not find any devices
-Create a device. We can use whatever identifier we want, so
-just grab a random UUID.
-.. code-block:: text
-    $ SOME_ID=$(uuidgen)
-    $ murano device enable ${SOME_ID} --expire 1
-    $ murano device list
-    +--------------------------------------+-------------+--------+
-    | Identifier                           | Status      | Online |
-    +--------------------------------------+-------------+--------+
-    | 1af384dd-57ba-4f13-9d89-45dbcbf207de | whitelisted | false  |
-    +--------------------------------------+-------------+--------+
-Provision the device. Murano generates and returns a CIK
-that we need to remember so that we can authenticate as
-the device when making calls on its behalf.
-.. code-block:: text
-    $ CIK=$(murano product device activate ${SOME_ID})
-    $ echo ${CIK}
-    MJzNuMqPDs7UADLriMlHK10dClv7cx46uLSkJLSw
-    $ murano device list
-    +--------------------------------------+-------------+--------+
-    | Identifier                           | Status      | Online |
-    +--------------------------------------+-------------+--------+
-    | 1af384dd-57ba-4f13-9d89-45dbcbf207de | provisioned | false  |
-    +--------------------------------------+-------------+--------+
-Generate Device Data
-====================
-Each solution (Application or Product) has its own URI.
-We need the Product's URI in order to interact with Murano
-on behalf of the device.
-Make a local variable for the Product URI.
-.. code-block:: text
-    $ PRODUCT_URI=$(murano domain product --brief --no-progress)
-NOTE: We need to use the ``--no-progress`` option, otherwise MurCLI
-will display a progress bar that contaminates the captured output.
-Write data to the device. E.g., let's write a very cold temperature value.
-.. code-block:: text
-    $ curl -si -k https://${PRODUCT_URI}/onep:v1/stack/alias \
-        -H "X-Exosite-CIK: ${CIK}" \
-        -H "Accept: application/x-www-form-urlencoded; charset=utf-8" \
-        -d reports='{"temperature": -40.0}' \
-        -i -v -w "%{http_code}"
-    [VERBOSE OUTPUT OMITTED]
-    204
-Verify that the data was passed from the Product to the Application and
-processed how we indicated in the event handler (which is to log it).
-.. code-block:: text
-    $ murano logs --application
-    DEBUG [n51cq3fea5zc40cs4_event] 2017-07-26T11:44:57.000-05:00:
-    EVENT: {
-        "connection_id":"D2bzFD6HSV3ih56dbswY",
-        "identity":"1af384dd-57ba-4f13-9d89-45dbcbf207de",
-        "ip":"123.234.012.234",
-        "protocol":"onep",
-        "timestamp":1.501087497424287e+15,
-        "type":"provisioned"
-        }
-    DEBUG [n51cq3fea5zc40cs4_event] 2017-07-26T14:09:30.000-05:00:
-    EVENT: {
-        "connection_id":"QWJeZcpXej5h5f5hwdLY",
-        "identity":"1af384dd-57ba-4f13-9d89-45dbcbf207de",
-        "ip":"123.234.012.234",
-        "payload":[{
-            "timestamp":1.501096170486053e+15,
-            "values":{
-                "reports":"{\"temperature\": -40.0}"}
-        }],
-        "protocol":"onep",
-        "timestamp":1.501096170487898e+15,
-        "type":"data_in"
-        }
-Success! You should see the ``temperature`` value in the last log message.
-You'll notice that the Product does not generate any log messages.
-.. code-block:: text
-    $ murano logs --product
-    # [NO OUTPUT]
-Create a Resource
-=================
-Bonus step! Create a resource for your data.
-NOTE: The write operation works regardless of having a resource defined.
-Create a resources file that describes the data. E.g.,
-.. code-block:: text
-    $ cat > specs/resources.yaml << EOF
-    ---
-    temperature:
-      allowed: []
-      format: number
-      settable: false
-      unit: ''
-    EOF
-Upload the resources to Murano.
-.. code-block:: text
-    $ murano syncup
-And write more data.
-.. code-block:: text
-    $ curl -si -k https://${PRODUCT_URI}/onep:v1/stack/alias \
-        -H "X-Exosite-CIK: ${CIK}" \
-        -H "Accept: application/x-www-form-urlencoded; charset=utf-8" \
-        -d raw_data='{"temperature": -19.9}' \
-        -i -v -w "%{http_code}"
-Verify that you see a new event in the log.
-.. code-block:: text
-    $ murano logs --application
-    DEBUG [n51cq3fea5zc40cs4_event] 2017-07-26T11:44:57.000-05:00:
-    EVENT: {
-        "connection_id":"D2bzFD6HSV3ih56dbswY",
-        "identity":"1af384dd-57ba-4f13-9d89-45dbcbf207de",
-        "ip":"123.234.012.234",
-        "protocol":"onep",
-        "timestamp":1.501087497424287e+15,
-        "type":"provisioned"
-        }
-    DEBUG [n51cq3fea5zc40cs4_event] 2017-07-26T14:09:30.000-05:00:
-    EVENT: {
-        "connection_id":"QWJeZcpXej5h5f5hwdLY",
-        "identity":"1af384dd-57ba-4f13-9d89-45dbcbf207de",
-        "ip":"123.234.012.234",
-        "payload":[{
-            "timestamp":1.501096170486053e+15,
-            "values":{
-                "reports":"{\"temperature\": -40.0}"}
-        }],
-        "protocol":"onep",
-        "timestamp":1.501096170487898e+15,
-        "type":"data_in"
-        }
-    DEBUG [n51cq3fea5zc40cs4_event] 2017-07-26T14:16:00.000-05:00:
-    EVENT: {
-        "connection_id":"3DD9rAZ95bgro5O0kGGD",
-        "identity":"1af384dd-57ba-4f13-9d89-45dbcbf207de",
-        "ip":"123.234.012.234",
-        "payload":[{
-            "timestamp":1.501096560116624e+15,
-            "values":{
-                "raw_data":"{\"temperature\": -19.9}"}
-        }],
-        "protocol":"onep",
-        "timestamp":1.501096560118335e+15,
-        "type":"data_in"
-        }
-*Et Voilà!*
-Congratulations of your first, very basic Murano project!