Tera Term のススメ

エンジニア系

• エンジニア系
  • システム開発
    • インフラエンジニア
      • サーバエンジニア
      • ネットワークエンジニア
      • データベースエンジニア
    • セキュリティエンジニア
    • ソフトウェアエンジニア
    • ウェブエンジニア(未掲載)
      • フロントエンドエンジニア
      • バックエンドエンジニア
    • クラウドエンジニア(未掲載)
  • コーポレートエンジニア
  • コンサルタント
  • ワーカー
  • 組込エンジニア
    • デバイス
    • 制御ソフト
• ステークホルダー
  • アプリ開発
    • デベロッパ
    • アプライアンス
    • その他
      • ソフトウェアエンジニア
      • プログラマ
      • コーダ
      • テスタ
      • デバッガ
  • 運用・保守
    • ヘルプデスク
    • オペレータ
    • 保守員
  • 管理
    • PM
    • PMO
    • PL
  • 発注
    • ビジネスオーナー

システム開発

インフラエンジニア

サーバエンジニア

ネットワークエンジニア

データベースエンジニア

セキュリティエンジニア

ソフトウェアエンジニア

ウェブエンジニア(未掲載)

フロントエンドエンジニア

バックエンドエンジニア

クラウドエンジニア(未掲載)

コーポレートエンジニア

コンサルタント

プリセールスエンジニア

ワーカー

組込エンジニア

デバイス

制御ソフト

ステークホルダー

アプリ開発

デベロッパ

アプライアンス

その他

ソフトウェアエンジニア

プログラマ

コーダ

テスタ

デバッガ

運用・保守

ヘルプデスク

オペレータ

保守員

管理

PM

PMO

PL

発注

ビジネスオーナー

シェルコマンド言語 コーディング規約案

ここでは、自分が使いやすい規約にしてみました。
臨機応変に変更してください。

Google Shell guide といったものも存在します。
https://google.github.io/styleguide/shellguide.html

• シェルコマンド言語 コーディング規約案
  • 汎用性の考慮
  • スクリプト
    • ファイル名
      • 拡張子
    • 実行権限
  • ファイル内容
    • 構成
    • 文字コード
    • 改行コード
    • インデント
    • シバン
    • ヘッダ
    • コメント
  • パラメータ関係
    • 変数名
      • プレフィックス
      • サフィックス
    • 利用時の指定方法
    • Exit Status
  • 関数関係
    • 関数名
      • プレフィックス
    • テンプレート関数
      • fnLog
      • fnDebug
      • fnErr
      • fnErrEnd
  • メイン
    • オプション解析
  • 備考
    • テンプレート
      • シェルスクリプト
      • 外部ファイル

汎用性の考慮

[Tips]
たとえば、Linux の for 文で C 言語のような ( i=0 ; i < x ; i++ ) という形式を利用できます。これは便利なのですが bash の独自実装なので汎用性が下がります。

スクリプト

ファイル名

拡張子

[Tips]
csh / tcsh / fish / bash / dash といった、シェルを複数利用するようなプロジェクトでは、拡張子をそれぞれに合わせた方が良いと思います。
bash しか利用しないことが分かっている環境で、シバンにも bash 指定のみの場合は .sh でも不都合はないと思います。

.src は、内容として bash なのですが source コマンド (ビルトインでは . コマンド) で呼ぶことを意図しています。

実行権限

[Tips]
権限を 755 や 700 で運用することは多いのですが、セキュリティを考慮すると、権限は最小限にすべきでしょう。
ここでは本番環境を想定していて、作成するユーザと、実行するユーザが異なることを考慮しています。
所有者は、更新できるが実行できない。前提条件を満たさない、不用意な実行を阻止できる。
グループ（実行者）は、更新できないが実行できる。JP1 のような自動実行ユーザのスクリプト改変を阻止できる。

ファイル内容

構成

文字コード

[Tips]
コメントに日本語を使わない場合は ASCII を指定してもよいです。
むしろ ASCII として認識されるでしょう。

改行コード

[Tips]
Windows でスクリプトを書くと、改行コードは考慮から漏れがちです。
Linux や UNIX 上で書くと気にしなくても良いのですが、プロジェクトの進行状況や管理方法次第で、どうしても Windows 端末での開発を行わなければならない状況もあります。
致命的ではない文字コードやインデントも指定するのですから、致命的エラーとなる改行コードは指定しておきましょう。

インデント

[Tips]
タブ (半角スペース4つもしくは8つ) だと、横に広がりすぎて視認性が悪くなることがあります。

シバン

#!/bin/bash

[Tips]
シバンとヘッダは、ひとまとめにしてしまっても良いかもしれません。
もしくは、拡張子の指定でシバンも固定することになるでしょう。

ヘッダ

# Script name: example.sh

# スクリプト名: example.sh
# 目的: スクリプトサンプル

コメント

# システム

パラメータ関係

変数名

[Tips]
私がスネークケースよりキャメルケースのほうが読みやすいと感じるタイプなので、キャメルケースを指定しています。
メリット・デメリットを考慮して、規定するのが良いです。

変数名はスクリプト上部にまとめて宣言しておくので、エディタの画面分割機能でコピペすることが前提としてあります。
画面分割は vim でも可能です。
変数名が短くても、何回も手入力していればタイポする可能性は高いです。

プレフィックス

サフィックス

利用時の指定方法

Exit Status

関数関係

関数名

プレフィックス

テンプレート関数

fnLog

fnLog "Sample message"

fnDebug

fnDebug "Debug message"

fnErr

fnErr "Standard Error message"

fnErrEnd

[ -d "/etc" ] || fnErrEnd 14 "/etc"
[ -f "/etc/hosts" ] || fnErrEnd 15 "/etc/hosts"
[ -x "/bin/ps" ] || fnErrEnd 13 "/bin/ps"

メイン

オプション解析

[Tips]

• help といったロングオプションを使いたい場合は、getopts ではなく、引数そのものを case で解析するほうがよいと思います。

備考

テンプレート

シェルスクリプト

#!/bin/bash
############################################################
# Script name: example.sh
# Modify     : yyyy.mm.dd 名前 初版作成
############################################################

### Parameter and Variable #################################
pCommon=./src/common.src
if [ -f "${pCommon}" ]; then
  . ${pCommon}
else
  echo "${pCommon} not exist."
  exit 1
fi

### Function ###############################################
fnEnd() {
  # スクリプト内で異常終了する際の Exit Status と、メッセージ内容の定義
  nExitStatus=$1
  case "${nExitStatus}" in
     0 ) fnLog "Script ${0##*/} end.";;
     * ) fnErr "Unknown error ($2)"; nExitStatus=1;;
  esac
  exit ${nExitStatus}
}

### Main ###################################################
fnLog "Script ${0##*/} start."

## オプション解析
while getopts h OPT; do
  case ${OPT} in
    h )
      fnDebug "Option h used."
      echo "Usage ${0##*/} [-h]"
      echo " [-h]    help messages."
      fnEnd 0
      ;;
    * )
      fnDebug "Unknown option used."
      fnErrEnd 10 "${OPT}"
      ;;
  esac
done

# xxx 処理


### End ####################################################
fnEnd 0

############################################################

外部ファイル

# 共通ファイル (common.src)

### Parameter and Variable #################################

## ディレクトリ
pLogDir="/var/log/script/"

## ファイル
pLogName=$(basename ${0%.*}.log)

## パス
# ログファイル
pLogPath="${pLogDir}${pLogName}"

# ヌルクリア
i=""
s=""

# Exit Status
nExitStatus=0

## フラグ
fDebugEnable=0

### Function ###############################################

# 目的：ログ出力
fnLog() {
  echo "$(date +'%Y/%m/%d %H:%M:%S') $*" >> ${pLogPath}
}

# 目的：デバッグ出力
fnLog() {
  [ "${fDebugEnable}" -eq "0" ] && fnLog "[Debug] $*"
}

# 目的：エラー出力
fnErr() {
  # ログ出力
  fnLog "$*"
  # 標準エラー出力
  echo "$(date +'%Y/%m/%d %H:%M:%S') $*" >&2
}

# 目的： エラー終了
fnErrEnd() {
  nExitStatus=${1}

  # 引数確認
  if [ -z "${nExitStatus}" ]; then
    fnErr "Not argument."
    exit 1
  fi

  case "${nExitStatus}" in
     0 ) fnErr "Function (fnErrEnd) argument error."; nExitStatus=1;;
    10 ) fnErr "Argument error ($2)";;
    11 ) fnErr "Read permission not exist ($2)";;
    12 ) fnErr "Write permission not exist ($2)";;
    13 ) fnErr "Exec permission not exist ($2)";;
    14 ) fnErr "Directory not exist ($2)";;
    15 ) fnErr "File not exist ($2)";;
     * ) fnErr "Unknown error ($2)";;
  esac
  exit ${nExitStatus}
}
||

実行中スクリプトの編集

• 実行中スクリプトの編集
  • 検証方法
  • 不意の修正に強くするためには
    • (1) 適切な権限を設定する
    • (2) 書換を検知する
    • (3) メモリに読み込む 1
    • (4) メモリに読み込む 2
  • まとめ
  • 感想

検証方法

#!/bin/bash
echo "Start"
sleep 30
echo "End"

不意の修正に強くするためには

(1) 適切な権限を設定する

$ sudo chmod -w sample.sh

(2) 書換を検知する

#!/bin/bash
before="$(ls -l $0)"

functionDiff() {
  after="$(ls -l $0)"
  [ "${before}" == "${after}" ] || echo "NG"
}

functionDiff

(3) メモリに読み込む 1

### example.conf

# Parameter or Variable
example="EXAMPLE"

# Function
exFunction() {
  echo "${example}"
}

#!/bin/bash
### Script name: example.sh
# Include
. ./example.conf

# Main
exFunction

(4) メモリに読み込む 2

#!/bin/bash
# script name : example.sh
echo a
echo b
echo c

envbar=$(cat /tmp/example.sh)
$ echo ${envbar}
#!/bin/bash # script name : example.sh echo a echo b echo c
$
$
$ echo "${envbar}"
#!/bin/bash
# script name : example.sh
echo a
echo b
echo c

envbar=$(cat /tmp/example.sh)
$ echo "${envbar}" | bash -
a
b
c

まとめ

感想