Pure bash program for auto-filling a template file with ENV variables












1












$begingroup$


Goal of Program



Consider a template file template.txt with double brace variables, intended to be replaced by values:



hello there {{ MY_VAR1 }}
some other stuff
some other stuff
foo: {{ MY_VAR2 }}
{{ MY_VAR2 }} is the value of MY_VAR2


and assume you have defined and exported those variables:



export MY_VAR1=val1
export MY_VAR2=val2


we want a script fill_template such that fill_template template.txt produces:



hello there val1
some other stuff
some other stuff
foo: val2
val2 is the value of MY_VAR2


and which gives an appropriate error message if any of the required template variables are not defined.



Code for review



Here is working code for fill_template:



#!/bin/bash

if [[ ! -f $1 ]]; then
>&2 echo "Usage: $0 <filename>"
exit 1
fi

# Gather all the required template variables

vars=()
while IFS= read -r line; do
vars+=( "$line" )
done < <( awk 'match($0, /{{ (.*) }}/, a) { print a[1] }' "$1" | sort -u )

# Verify that all template variables are set and exported

missing=()
for var in "${vars[@]}"; do
if [[ -z ${!var+x} ]]; then
missing+=( "$var" )
fi
done

if [[ ${#missing[@]} -gt 0 ]]; then
>&2 echo "The following required variables have not been set and exported:"
for var in "${missing[@]}"; do
>&2 echo "${var}"
done
exit 1
fi

# Dynamically construct the sed cmd to do the replacement

sed_cmd=
for var in "${vars[@]}"; do
sed_cmd+="s/\{\{ *${var} *}}/${!var}/g;"
done

sed -E "${sed_cmd}" "$1"


Notes




  • All comments welcome, from the high-level approach to nitpicks.

  • Currently we assume there will be only one {{ TEMPLATE_VAR }} per line









share









$endgroup$

















    1












    $begingroup$


    Goal of Program



    Consider a template file template.txt with double brace variables, intended to be replaced by values:



    hello there {{ MY_VAR1 }}
    some other stuff
    some other stuff
    foo: {{ MY_VAR2 }}
    {{ MY_VAR2 }} is the value of MY_VAR2


    and assume you have defined and exported those variables:



    export MY_VAR1=val1
    export MY_VAR2=val2


    we want a script fill_template such that fill_template template.txt produces:



    hello there val1
    some other stuff
    some other stuff
    foo: val2
    val2 is the value of MY_VAR2


    and which gives an appropriate error message if any of the required template variables are not defined.



    Code for review



    Here is working code for fill_template:



    #!/bin/bash

    if [[ ! -f $1 ]]; then
    >&2 echo "Usage: $0 <filename>"
    exit 1
    fi

    # Gather all the required template variables

    vars=()
    while IFS= read -r line; do
    vars+=( "$line" )
    done < <( awk 'match($0, /{{ (.*) }}/, a) { print a[1] }' "$1" | sort -u )

    # Verify that all template variables are set and exported

    missing=()
    for var in "${vars[@]}"; do
    if [[ -z ${!var+x} ]]; then
    missing+=( "$var" )
    fi
    done

    if [[ ${#missing[@]} -gt 0 ]]; then
    >&2 echo "The following required variables have not been set and exported:"
    for var in "${missing[@]}"; do
    >&2 echo "${var}"
    done
    exit 1
    fi

    # Dynamically construct the sed cmd to do the replacement

    sed_cmd=
    for var in "${vars[@]}"; do
    sed_cmd+="s/\{\{ *${var} *}}/${!var}/g;"
    done

    sed -E "${sed_cmd}" "$1"


    Notes




    • All comments welcome, from the high-level approach to nitpicks.

    • Currently we assume there will be only one {{ TEMPLATE_VAR }} per line









    share









    $endgroup$















      1












      1








      1





      $begingroup$


      Goal of Program



      Consider a template file template.txt with double brace variables, intended to be replaced by values:



      hello there {{ MY_VAR1 }}
      some other stuff
      some other stuff
      foo: {{ MY_VAR2 }}
      {{ MY_VAR2 }} is the value of MY_VAR2


      and assume you have defined and exported those variables:



      export MY_VAR1=val1
      export MY_VAR2=val2


      we want a script fill_template such that fill_template template.txt produces:



      hello there val1
      some other stuff
      some other stuff
      foo: val2
      val2 is the value of MY_VAR2


      and which gives an appropriate error message if any of the required template variables are not defined.



      Code for review



      Here is working code for fill_template:



      #!/bin/bash

      if [[ ! -f $1 ]]; then
      >&2 echo "Usage: $0 <filename>"
      exit 1
      fi

      # Gather all the required template variables

      vars=()
      while IFS= read -r line; do
      vars+=( "$line" )
      done < <( awk 'match($0, /{{ (.*) }}/, a) { print a[1] }' "$1" | sort -u )

      # Verify that all template variables are set and exported

      missing=()
      for var in "${vars[@]}"; do
      if [[ -z ${!var+x} ]]; then
      missing+=( "$var" )
      fi
      done

      if [[ ${#missing[@]} -gt 0 ]]; then
      >&2 echo "The following required variables have not been set and exported:"
      for var in "${missing[@]}"; do
      >&2 echo "${var}"
      done
      exit 1
      fi

      # Dynamically construct the sed cmd to do the replacement

      sed_cmd=
      for var in "${vars[@]}"; do
      sed_cmd+="s/\{\{ *${var} *}}/${!var}/g;"
      done

      sed -E "${sed_cmd}" "$1"


      Notes




      • All comments welcome, from the high-level approach to nitpicks.

      • Currently we assume there will be only one {{ TEMPLATE_VAR }} per line









      share









      $endgroup$




      Goal of Program



      Consider a template file template.txt with double brace variables, intended to be replaced by values:



      hello there {{ MY_VAR1 }}
      some other stuff
      some other stuff
      foo: {{ MY_VAR2 }}
      {{ MY_VAR2 }} is the value of MY_VAR2


      and assume you have defined and exported those variables:



      export MY_VAR1=val1
      export MY_VAR2=val2


      we want a script fill_template such that fill_template template.txt produces:



      hello there val1
      some other stuff
      some other stuff
      foo: val2
      val2 is the value of MY_VAR2


      and which gives an appropriate error message if any of the required template variables are not defined.



      Code for review



      Here is working code for fill_template:



      #!/bin/bash

      if [[ ! -f $1 ]]; then
      >&2 echo "Usage: $0 <filename>"
      exit 1
      fi

      # Gather all the required template variables

      vars=()
      while IFS= read -r line; do
      vars+=( "$line" )
      done < <( awk 'match($0, /{{ (.*) }}/, a) { print a[1] }' "$1" | sort -u )

      # Verify that all template variables are set and exported

      missing=()
      for var in "${vars[@]}"; do
      if [[ -z ${!var+x} ]]; then
      missing+=( "$var" )
      fi
      done

      if [[ ${#missing[@]} -gt 0 ]]; then
      >&2 echo "The following required variables have not been set and exported:"
      for var in "${missing[@]}"; do
      >&2 echo "${var}"
      done
      exit 1
      fi

      # Dynamically construct the sed cmd to do the replacement

      sed_cmd=
      for var in "${vars[@]}"; do
      sed_cmd+="s/\{\{ *${var} *}}/${!var}/g;"
      done

      sed -E "${sed_cmd}" "$1"


      Notes




      • All comments welcome, from the high-level approach to nitpicks.

      • Currently we assume there will be only one {{ TEMPLATE_VAR }} per line







      bash





      share












      share










      share



      share










      asked 8 mins ago









      JonahJonah

      3,439717




      3,439717






















          0






          active

          oldest

          votes












          Your Answer





          StackExchange.ifUsing("editor", function () {
          return StackExchange.using("mathjaxEditing", function () {
          StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
          StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
          });
          });
          }, "mathjax-editing");

          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "196"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: false,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: null,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216569%2fpure-bash-program-for-auto-filling-a-template-file-with-env-variables%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes
















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Code Review Stack Exchange!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          Use MathJax to format equations. MathJax reference.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f216569%2fpure-bash-program-for-auto-filling-a-template-file-with-env-variables%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Costa Masnaga

          Fotorealismo

          Sidney Franklin