実行前に実行確認をする - OpenStandia Wiki - OpenStandia

実行前に実行確認をする

｢実行前に実行確認をする｣とは、ある一定条件のもとでしかインストール処理をしないなどの場合に用います。
(例)
データベース接続ができた場合のみ、SQL1を実行、続いてSQL2を実行する。
※ 逆に言うと、データベース接続ができない場合は、SQL1、SQL2はともに実行しないということになります。

1. スタックファイルを定義する
   

   <?xml version="1.0" encoding="Shift_JIS"?>
   <!DOCTYPE product PUBLIC
     "-//OpenStandia/Installer//DTD Product Configuration 1.0//EN"
     "http://openstandia.sourceforge.jp/dtd/product_1_0.dtd">
   
   <stack>
     <application>
       <name>サンプルスタック</name>
       <ver>1.0.2.0</ver>
       <description>スタックのサンプルです。</description>
       <properties>
         <products-dir>products/samples</products-dir>
       </properties>
     </application>
     <install-befores/>
     <products>
       <product no="17" name="実行前に実行確認をする" def="${stack.application.properties.products-dir}/check-exec-1.0.0/win.xml"/>
       <product no="18" name="実行前に実行確認をする" def="${stack.application.properties.products-dir}/check-exec-1.0.0/linux.xml"/>
     </products>
     <install-afters/>
   </stack>
   

   これは、｢実行前に実行確認をする｣というプロダクトが、
   ｢products/samples/check-exec-1.0.0/win.xml｣ もしくは、 ｢products/samples/check-exec-1.0.0/linux.xml｣
   に定義されているという意味です。
   
2. プロダクトファイル(Windows/Linux)を定義する
   
   1. Windowsの場合
      

      <?xml version="1.0" encoding="Shift_JIS"?>
      <!DOCTYPE product PUBLIC
        "-//OpenStandia/Installer//DTD Product Configuration 1.0//EN"
        "http://openstandia.sourceforge.jp/dtd/product_1_0.dtd">
      
      <product os="windows">
        <name>Check Execute</name>
        <ver>1.0.0</ver>
        <required>false</required>
        <localDir>products\samples\check-exec-${product.ver}</localDir>
        <description>実行前に実行確認をする。</description>
        <properties/>
        <config>
          <pattern sub="1">実行していい</pattern>
          <pattern sub="2">実行してはダメ</pattern>
        </config>
        <files>
          <file url="http://localhost/samples/check-exec/sh/check/check-${product.ver}.bat">sh\check\check.bat</file>
        </files>
        <execs>
          <install>
            <check cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>sh\check\check.bat</arg>
                <arg>${sub}</arg>
              </args>
            </check>
            <exec cmd="calc.exe"/>
          </install>
          <uninstall>
            <check cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>sh\check\check.bat</arg>
                <arg>${sub}</arg>
              </args>
            </check>
            <exec cmd="calc.exe"/>
          </uninstall>
          <update>
            <check cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>sh\check\check.bat</arg>
                <arg>${sub}</arg>
              </args>
            </check>
            <exec cmd="calc.exe"/>
          </update>
        </execs>
      </product>
      

   2. Linuxの場合
      

      <?xml version="1.0" encoding="Shift_JIS"?>
      <!DOCTYPE product PUBLIC
        "-//OpenStandia/Installer//DTD Product Configuration 1.0//EN"
        "http://openstandia.sourceforge.jp/dtd/product_1_0.dtd">
      
      <product os="linux">
        <name>Check Execute</name>
        <ver>1.0.0</ver>
        <required>false</required>
        <localDir>products/samples/check-exec-${product.ver}</localDir>
        <description>実行前に実行確認をする。</description>
        <properties/>
        <config>
          <pattern sub="1">実行していい</pattern>
          <pattern sub="2">実行してはダメ</pattern>
        </config>
        <files>
          <file url="http://localhost/samples/check-exec/sh/check/check-${product.ver}.sh">sh/check/check.sh</file>
        </files>
        <execs>
          <install>
            <check cmd="sh">
              <args>
                <arg>sh/check/check.sh</arg>
                <arg>${sub}</arg>
              </args>
            </check>
            <exec cmd="xclock"/>
          </install>
          <uninstall>
            <check cmd="sh">
              <args>
                <arg>sh/check/check.sh</arg>
                <arg>${sub}</arg>
              </args>
            </check>
            <exec cmd="xclock"/>
          </uninstall>
          <update>
            <check cmd="sh">
              <args>
                <arg>sh/check/check.sh</arg>
                <arg>${sub}</arg>
              </args>
            </check>
            <exec cmd="xclock"/>
          </update>
        </execs>
      </product>
      

      これは、｢実行前に実行確認をする｣というプロダクトが、
      Windowsでは｢check.bat｣、Linuxでは｢check.sh｣を実行し、このバッチ(シェル)のリターンコードにより
      ｢calc.exe｣(電卓)を、Linuxでは｢xclock｣(時計)を実行(起動)する/しないという意味です。
      ※ バッチ(シェル)が返却するリターンコードの仕様は、
      0を返却した場合･･･続くexec要素群を総て実行する
      0以外を返却した場合･･･続くexec要素群を総て実行しない
      となります。
      ここでは、インストール時に｢1:実行していい/2:実行してはダメ｣を選択させ
      この値を、バッチ(シェル)の引数としこの引数値によりリターンコードを設定しているだけです。
      
   • インストール、アンインストール、アップデート総てにおいて同処理としてます。
     
   • config要素に関しては、設定ファイル選択させるを参照してください。
     
     
3. 各ディレクトリ、各ファイルを以下のように配置する
   OpenStandiaIntaller
   　|--bin
   　|--create
   　|--lib
   　|--products
   　|　　|--samples
   　|　　 　　|--check-exe-1.0.0
   　|　　 　　 　　|--linux.xml
   　|　　 　　 　　|--win.xml
   　|　　 　　 　　|--sh
   　|　　 　　 　　|　　|--check
   　|　　 　　 　　|　　 　　|--check.bat
   　|　　 　　 　　|　　 　　|--check.sh
   　|--scripts
   　|--stack-sample.xml
   GUIの場合は、以上で終了です。
   OpenStandia/GUI Installerより上記で作成したスタックファイルを読み込ませることで実行できるはずです。
   CUIの場合は、引き続き以下を行ってください。
   
   
4. 起動バッチ(setup.bat)、起動シェル(setup.sh)の作成(編集)
   
   1. Windowsの場合
      
      1. OpenStandia/Installerに付属の起動バッチ(setup.bat)をメモ帳等で開いてください。
         
      2. 【初期設定】項目に使用するスタックファイルを定義する(l.4付近)
         
         REM ##### 初期設定 #####
         set OPENSTANDIA_INSTALLER_VER=sample
         set STACK_XML=stack-%OPENSTANDIA_INSTALLER_VER%.xml
         
         
         • ここでは、｢stack-sample.xml｣となるように定義しています。
           
      3. 【初期設定】項目にプロダクトの番号を定義する(l.4付近)
         
         REM ##### 初期設定 #####
         set OPENSTANDIA_INSTALLER_VER=sample
         set STACK_XML=stack-%OPENSTANDIA_INSTALLER_VER%.xml
         set ANT_DIR=apache-ant-1.7.0
         set SCRIPTS_DIR=scripts
         set CHECK_EXEC_NO=17
         
         
         • スタックファイルに記述した該当プロダクトの番号(stack.products.product.no)の値である必要があります。
           
      4. 【問い合わせ】項目を記述する(l.79付近)
         
         REM ##### 問い合わせ #####
         cls
         REM check-exec
         set CHECK_EXEC=y
         set /p CHECK_EXEC=実行前に実行確認をするサンプルを実行しますか？(y/n) [y]
         set CHECK_EXEC_CONF=1
         if "%CHECK_EXEC%" == "y" (
         　　echo 実行確認の結果を選択してください。
         　　echo 1 : 実行していい
         　　echo 2 : 実行してはダメ
         　　set /p CHECK_EXEC_CONF=
         )
         
         
      5. 【ダウンロード実行】項目を記述する(l.124付近)
         
         REM ##### ダウンロード実行 #####
         echo.
         echo ダウンロード処理を開始します...
         if "%CHECK_EXEC%" == "y" (
         　　call ant -Dno=%CHECK_EXEC_NO% -DstackXml=%STACK_XML% -f "%SCRIPTS_DIR%download.xml"
         　　if errorlevel 1 goto error
         )
         
         
         • ｢"%CHECK_EXEC%" == "y"｣の部分の｢%CHECK_EXEC%｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢-Dno=%CHECK_EXEC_NO%｣の部分の｢%CHECK_EXEC_NO%｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           
      6. 【インストール実行】項目を記述する(l.124付近)
         
         REM ##### インストール実行 #####
         set INSTALLED_NO=
         echo.
         echo %MODE_STR%処理を開始します...
         if "%CHECK_EXEC%" == "y" (
         　　set INSTALLED_NO=%INSTALLED_NO%,%CHECK_EXEC_NO%
         　　call ant -Dno=%CHECK_EXEC_NO% -Dsub=%CHECK_EXEC_CONF% -Dmode=%MODE% -DinstalledNo="%INSTALLED_NO%" -DstackXml=%STACK_XML% -f "%SCRIPTS_DIR%install.xml"
         　　if errorlevel 1 goto error
         )
         
         
         • ｢"%CHECK_EXEC%" == "y"｣の部分の｢%CHECK_EXEC%｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢set INSTALLED_NO=%INSTALLED_NO%,%CHECK_EXEC_NO%｣及び｢-Dno=%CHECK_EXEC_NO%｣の部分の｢%CHECK_EXEC_NO%｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           
   2. Linuxの場合
      
      1. OpenStandia/Installerに付属の起動シェル(setup.sh)をUTF-8で編集できるエディター等で開いてください。
         
      2. 【初期設定】項目に使用するスタックファイルを定義する(l.5付近)
         
         ##### 初期設定 #####
         OS_LANG=UTF-8
         OPENSTANDIA_INSTALLER_VER=sample
         STACK_XML=stack-${OPENSTANDIA_INSTALLER_VER}.xml
         
         
         • ここでは、｢stack-sample.xml｣となるように定義しています。
           
      3. 【初期設定】項目にプロダクトの番号を定義する(l.5付近)
         
         ##### 初期設定 #####
         OS_LANG=UTF-8
         OPENSTANDIA_INSTALLER_VER=sample
         STACK_XML=stack-${OPENSTANDIA_INSTALLER_VER}.xml
         ANT_DIR=apache-ant-1.7.0
         SCRIPTS_DIR=scripts
         CHECK_EXEC_NO=18
         
         
         • スタックファイルに記述した該当プロダクトの番号(stack.products.product.no)の値である必要があります。
           
      4. 【問い合わせ】項目を記述する(l.85付近)
         
         ##### 問い合わせ #####
         clear
         # check-exec
         read -p "実行前に実行確認をするサンプルを実行しますか？(y/n) [y]" CHECK_EXEC
         if [ "${CHECK_EXEC}" = "" ]; then
         　　CHECK_EXEC=y
         fi
         CHECK_EXEC_CONF=1
         if [ "${CHECK_EXEC}" = "y" ]; then
         　　echo 設定ファイルを選択してください。
         　　echo 1 : 実行していい
         　　echo 2 : 実行してはダメ
         　　read CHECK_EXEC_CONF
         fi
         
         
      5. 【ダウンロード実行】項目を記述する(l.146付近)
         
         ##### ダウンロード実行 #####
         echo
         echo ダウンロード処理を開始します...
         if [ "${CHECK_EXEC}" = "y" ]; then
         　　ant -Dno=${CHECK_EXEC_NO} -DstackXml=${STACK_XML} -f "${SCRIPTS_DIR}download.xml"
         　　if [ $? -ne 0 ]; then error_func; fi
         fi
         
         
         • ｢"${CHECK_EXEC}" = "y"｣の部分の｢${CHECK_EXEC}｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢-Dno=${CHECK_EXEC_NO}｣の部分の｢${CHECK_EXEC_NO}｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           
      6. 【インストール実行】項目を記述する(l.183付近)
         
         ##### インストール実行 #####
         INSTALLED_NO=
         echo
         echo ${MODE_STR}処理を開始します...
         if [ "${CHECK_EXEC}" = "y" ]; then
         　　INSTALLED_NO=${INSTALLED_NO},${CHECK_EXEC_NO}
         　　ant -Dno=${CHECK_EXEC_NO} -Dsub=${CHECK_EXEC_CONF} -Dmode=${MODE} -DinstalledNo="${INSTALLED_NO}" -DstackXml=${STACK_XML} -f "${SCRIPTS_DIR}install.xml"
         　　if [ $? -ne 0 ]; then error_func; fi
         fi
         
         
         • ｢"${CHECK_EXEC}" = "y"｣の部分の｢${CHECK_EXEC}｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢INSTALLED_NO=${INSTALLED_NO},${CHECK_EXEC_NO}｣及び｢-Dno=${CHECK_EXEC_NO}｣の部分の｢${CHECK_EXEC_NO}｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           

以上でCUIの場合も終了です。
各起動バッチ、シェルを実行することで実行できるはずです。