Implement set-env-var step (#1)

* Implement set-env-var step

* Fix error message for missing value

* Update title, fix is_required fields

Author: kdobmayer

.gitignore

@@ -0,0 +1,2 @@
+.bitrise*
+.gows.user.yml

Gopkg.lock

@@ -0,0 +1,3 @@
+[[constraint]]
+  name = "github.com/bitrise-io/go-utils"
+  branch = "master"

Gopkg.toml

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 bitrise-steplib
+
+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.

LICENSE

@@ -1 +1,93 @@
-# steps-set-env-var
+# set-env-var
+
+Set environment variable
+
+
+## How to use this Step
+
+Can be run directly with the [bitrise CLI](https://github.com/bitrise-io/bitrise),
+just `git clone` this repository, `cd` into it's folder in your Terminal/Command Line
+and call `bitrise run test`.
+
+*Check the `bitrise.yml` file for required inputs which have to be
+added to your `.bitrise.secrets.yml` file!*
+
+Step by step:
+
+1. Open up your Terminal / Command Line
+2. `git clone` the repository
+3. `cd` into the directory of the step (the one you just `git clone`d)
+5. Create a `.bitrise.secrets.yml` file in the same directory of `bitrise.yml`
+   (the `.bitrise.secrets.yml` is a git ignored file, you can store your secrets in it)
+6. Check the `bitrise.yml` file for any secret you should set in `.bitrise.secrets.yml`
+  * Best practice is to mark these options with something like `# define these in your .bitrise.secrets.yml`, in the `app:envs` section.
+7. Once you have all the required secret parameters in your `.bitrise.secrets.yml` you can just run this step with the [bitrise CLI](https://github.com/bitrise-io/bitrise): `bitrise run test`
+
+An example `.bitrise.secrets.yml` file:
+
+```
+envs:
+- A_SECRET_PARAM_ONE: the value for secret one
+- A_SECRET_PARAM_TWO: the value for secret two
+```
+
+## How to create your own step
+
+1. Create a new git repository for your step (**don't fork** the *step template*, create a *new* repository)
+2. Copy the [step template](https://github.com/bitrise-steplib/step-template) files into your repository
+3. Fill the `step.sh` with your functionality
+4. Wire out your inputs to `step.yml` (`inputs` section)
+5. Fill out the other parts of the `step.yml` too
+6. Provide test values for the inputs in the `bitrise.yml`
+7. Run your step with `bitrise run test` - if it works, you're ready
+
+__For Step development guidelines & best practices__ check this documentation: [https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md](https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md).
+
+**NOTE:**
+
+If you want to use your step in your project's `bitrise.yml`:
+
+1. git push the step into it's repository
+2. reference it in your `bitrise.yml` with the `git::PUBLIC-GIT-CLONE-URL@BRANCH` step reference style:
+
+```
+- git::https://github.com/user/my-step.git@branch:
+   title: My step
+   inputs:
+   - my_input_1: "my value 1"
+   - my_input_2: "my value 2"
+```
+
+You can find more examples of step reference styles
+in the [bitrise CLI repository](https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml#L65).
+
+## How to contribute to this Step
+
+1. Fork this repository
+2. `git clone` it
+3. Create a branch you'll work on
+4. To use/test the step just follow the **How to use this Step** section
+5. Do the changes you want to
+6. Run/test the step before sending your contribution
+  * You can also test the step in your `bitrise` project, either on your Mac or on [bitrise.io](https://www.bitrise.io)
+  * You just have to replace the step ID in your project's `bitrise.yml` with either a relative path, or with a git URL format
+  * (relative) path format: instead of `- original-step-id:` use `- path::./relative/path/of/script/on/your/Mac:`
+  * direct git URL format: instead of `- original-step-id:` use `- git::https://github.com/user/step.git@branch:`
+  * You can find more example of alternative step referencing at: https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml
+7. Once you're done just commit your changes & create a Pull Request
+
+
+## Share your own Step
+
+You can share your Step or step version with the [bitrise CLI](https://github.com/bitrise-io/bitrise). If you use the `bitrise.yml` included in this repository, all you have to do is:
+
+1. In your Terminal / Command Line `cd` into this directory (where the `bitrise.yml` of the step is located)
+1. Run: `bitrise run test` to test the step
+1. Run: `bitrise run audit-this-step` to audit the `step.yml`
+1. Check the `share-this-step` workflow in the `bitrise.yml`, and fill out the
+   `envs` if you haven't done so already (don't forget to bump the version number if this is an update
+   of your step!)
+1. Then run: `bitrise run share-this-step` to share the step (version) you specified in the `envs`
+1. Send the Pull Request, as described in the logs of `bitrise run share-this-step`
+
+That's all ;)

README.md

@@ -0,0 +1,89 @@
+format_version: 4
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+
+app:
+  envs:
+  - BITRISE_STEP_ID: set-env-var
+  - BITRISE_STEP_VERSION: "0.9.0"
+  - BITRISE_STEP_GIT_CLONE_URL: https://github.com/bitrise-steplib/steps-set-env-var.git
+  - MY_STEPLIB_REPO_FORK_GIT_URL: $MY_STEPLIB_REPO_FORK_GIT_URL
+  - VALUE: source-env-var-value 
+
+workflows:
+  test:
+    steps:
+    - change-workdir:
+        title: Switch working dir to test / _tmp dir
+        description: |-
+          To prevent step testing issues, like referencing relative
+          files with just './some-file' in the step's code, which would
+          work for testing the step from this directory directly
+          but would break if the step is included in another `bitrise.yml`.
+        run_if: true
+        inputs:
+        - path: ./_tmp
+        - is_create_path: true
+    - path::./:
+        title: Step Test
+        run_if: true
+        inputs:
+        - value: ${VALUE}
+        - destination_keys: DEST_ENV_VAR_1 DEST_ENV_VAR_2 DEST_ENV_VAR_3
+    - script:
+        inputs:
+        - content: |-
+            #!/usr/bin/env bash
+            set -u
+            echo "DEST_ENV_VAR_1: $DEST_ENV_VAR_1"
+            echo "DEST_ENV_VAR_2: $DEST_ENV_VAR_2"
+            echo "DEST_ENV_VAR_3: $DEST_ENV_VAR_3"
+  # ----------------------------------------------------------------
+  # --- workflows to Share this step into a Step Library
+  audit-this-step:
+    steps:
+    - script:
+        inputs:
+        - content: |-
+            #!/bin/bash
+            set -ex
+            stepman audit --step-yml ./step.yml
+
+  share-this-step:
+    envs:
+      # if you want to share this step into a StepLib
+      - MY_STEPLIB_REPO_FORK_GIT_URL: $MY_STEPLIB_REPO_FORK_GIT_URL
+      - BITRISE_STEP_ID: $BITRISE_STEP_ID
+      - BITRISE_STEP_VERSION: $BITRISE_STEP_VERSION
+      - BITRISE_STEP_GIT_CLONE_URL: $BITRISE_STEP_GIT_CLONE_URL
+    description: |-
+      If this is the first time you try to share a Step you should
+      first call: $ bitrise share
+
+      This will print you a guide, and information about how Step sharing
+      works. Please read it at least once!
+
+      As noted in the Step sharing guide you'll have to fork the
+      StepLib you want to share this step into. Once you're done with forking
+      the repository you should set your own fork's git clone URL
+      in the `.bitrise.secrets.yml` file, or here in the `envs` section,
+      as the value of the `MY_STEPLIB_REPO_FORK_GIT_URL` environment.
+
+      You're now ready to share this Step, just make sure that
+      the `BITRISE_STEP_ID` and `BITRISE_STEP_VERSION`
+      environments are set to the desired values!
+
+      To share this Step into a StepLib you can just run: $ bitrise run share-this-step
+
+      Once it finishes the only thing left is to actually create a Pull Request,
+      the way described in the guide printed at the end of the process.
+    before_run:
+    - audit-this-step
+    steps:
+    - script:
+        inputs:
+        - content: |-
+            #!/bin/bash
+            set -ex
+            bitrise share start -c "${MY_STEPLIB_REPO_FORK_GIT_URL}"
+            bitrise share create --stepid "${BITRISE_STEP_ID}" --tag "${BITRISE_STEP_VERSION}" --git "${BITRISE_STEP_GIT_CLONE_URL}"
+            bitrise share finish

bitrise.yml

@@ -0,0 +1,65 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/bitrise-io/go-utils/log"
+)
+
+// ConfigsModel ...
+type ConfigsModel struct {
+	Value           string
+	DestinationKeys string
+}
+
+func createConfigsModelFromEnvs() ConfigsModel {
+	return ConfigsModel{
+		Value:           os.Getenv("value"),
+		DestinationKeys: os.Getenv("destination_keys"),
+	}
+}
+
+func (configs ConfigsModel) print() {
+	log.Infof("Configs:")
+	log.Printf("- Value: %s", configs.Value)
+	log.Printf("- DestinationKeys: %s", configs.DestinationKeys)
+}
+
+func (configs ConfigsModel) validate() error {
+	if configs.DestinationKeys == "" {
+		return errors.New("no DestinationKeys parameter specified")
+	}
+	return nil
+}
+
+func main() {
+	configs := createConfigsModelFromEnvs()
+
+	fmt.Println()
+	configs.print()
+	fmt.Println()
+
+	if err := configs.validate(); err != nil {
+		log.Errorf("Issue with input: %s", err)
+		os.Exit(1)
+	}
+
+	if configs.Value == "" {
+		log.Warnf("The value is empty")
+		fmt.Println()
+	}
+
+	log.Infof("Exported environment variables:")
+	for _, dest := range strings.Split(configs.DestinationKeys, " ") {
+		cmdLog, err := exec.Command("bitrise", "envman", "add", "--key", dest, "--value", configs.Value).CombinedOutput()
+		if err != nil {
+			fmt.Printf("Failed to expose output with envman, error: %#v | output: %s", err, cmdLog)
+			os.Exit(1)
+		}
+		fmt.Printf("- %s: %s\n", dest, configs.Value)
+	}
+}

main.go

@@ -0,0 +1,45 @@
+title: |-
+  Set environment variable
+summary: |
+  Set environment variable
+description: |
+  With this step you can copy a value into as many environment variables as you like.
+website: https://github.com/bitrise-steplib/steps-set-env-var
+source_code_url: https://github.com/bitrise-steplib/steps-set-env-var
+support_url: https://github.com/bitrise-steplib/steps-set-env-var/issues
+host_os_tags:
+  - osx-10.10
+  - ubuntu
+type_tags:
+  - utility
+is_requires_admin_user: false
+is_always_run: false
+is_skippable: false
+run_if: ""
+
+toolkit:
+  go:
+    package_name: github.com/bitrise-steplib/steps-set-env-var
+
+inputs:
+  - value:
+    opts:
+      title: "Value for copy into Envirhnment variables"
+      summary: "Value for copy into Environment variables"
+      description: |
+        The value will be copied into the destination environment variables.
+      is_expand: true
+      is_required: false
+      value_options: []
+  - destination_keys:
+    opts:
+      title: "Destination Environment variables"
+      summary:  "Destination Environment variables"
+      description: |
+        Space separated list of the keys of the destination environment variables.
+        The value will be copied into these environment variables.
+
+        `envman add --key [destination_key] --value [value]`
+      is_expand: true
+      is_required: true
+      value_options: []