Casual Developers Note

エンジニアやデザイナー向けの技術情報・英語学習情報・海外留学情報・海外旅行情報を提供中。世界を旅して人生を楽しもう。

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • お問い合わせ
現在の場所:ホーム / アーカイブcircleci

2018年10月26日 By KD コメントを書く

CircleCI 2.0で.envファイルを環境変数として使う方法

CircleCI 2.0で.envファイルを環境変数として使う方法

CircleCI 2.0に環境変数を一つ一つ登録するのではなく.envファイルとして扱う方法はとても便利です。今回はCircleCI 2.0に.envファイルを環境変数として登録して使う方法を紹介します。

はじめに

アプリケーションでGitにコミットできない情報として環境変数があります。環境変数にはAPIキーなどのいろいろな機密情報が含まれているわけですが、どこかのサーバーにアプリケーションをデプロイする場合は、当然そのサーバーに環境変数を登録する必要があります。この環境変数をファイルにまとめたものが.envファイルです。Docker Composeでも簡単に読み込めるため、とても便利です。

ただ、ローカルでは.envファイルはそのまま使っても問題ありませんが、サーバー上やCircleCIなどのサービス上で扱う場合はセキュリティを担保しつつ利用するか、あるいは利用しないで環境変数を直接登録する必要があります。

今回は.envファイルを安全に扱う一つの方法として、base64にして環境変数に登録する方法を紹介します。

Base64とは?

Base64とは、データを64種類の印字可能な英数字のみで表現するエンコード方式で、7ビットのデータしか扱うことの出来ない通信環境でデータを扱うために使います。7ビットのデータしか扱うことの出来ない通信環境の例は電子メールで、電子メールの添付ファイルはBase64エンコードされて文字列として送信されています。

これを応用すると、.envファイルを文字列に変換して利用できます。

.envファイルを環境変数に登録する

プロジェクトのカレントディレクトリに.envファイルがある前提で進めます。

.envファイルをbase64エンコードする

以下のコマンドでbase64エンコードすると、.envファイルを文字列に変換できます。

$ cat .env | base64

CircleCIの環境変数として登録する

Base64エンコードした文字列を環境変数として登録します。今回は「ENV_FILE」という環境変数名で登録しています

Circleci env1

CircleCIのジョブ内でbase64デコードして使う

CirlceCI 2.0の設定ファイルconfig.ymlに以下のタスクをアプリケーションが環境変数を利用する前に追記します。

- run:
    name: Decode dotenv file
    command: echo $ENV_FILE | base64 --decode > .env

実際にCircleCIで実行すると以下のようにデコードされ、後の処理で.envファイルを利用できます。

Circleci env2

当然、.envファイルの利用自体はアプリケーションやらDocker Composeやらに書いておく必要があります。

最後に

いかがでしたか?これでCircleCI 2.0で.envファイルを環境変数として扱る方法が分かったと思います。必要な場面で試してみて下さい。では。

カテゴリ : 技術 Tips & Tutorials タグ : circleci, dotenv

2018年8月13日 By KD コメントを書く

CircleCI 2.0とCodecovでNodeJSアプリケーションをテストしてカバレッジを測定する方法(Jest編)

CircleCI 2.0とCodecovでNodeJSアプリケーションをテストしてカバレッジを測定する方法(Jest編)

最近はJavaScriptのテストツールとしてmochaやnycの代わりにJestを使うことが多くなってきました。今回は、CircleCI 2.0とCodecovでNodeJSアプリケーションのテストカバレッジを測定する方法をJestを使った場合で紹介します。

はじめに

以前の「CircleCI 2.0とCodecovでNodeJSアプリケーションをテストしてカバレッジを測定する方法(CircleCI 2.0のDockerコンテナ利用版)」という記事で、CircleCI 2.0とCodecovでテストカバレッジを測定する方法を紹介しましたが、その時はテストツールとして、mochaとnycで使っていました。今回は、以前の記事の内容を、テストツールとしてJestを使う形で紹介します。

前提

以下を前提とします。詳しくは以前の記事を見て下さい。

  • GitHubのアカウントがあること
  • CircleCIのアカウントがあること
  • CodeCovのアカウントがあること
  • 何かしらのNodeJSアプリケーションを作ってあること

必要なパッケージをインストールする

それでは始めましょう。プロジェクトに行き、Jestをインストールします。

$ cd my-nodejs-with-test-project
$ yarn add --dev jest

package.jsonにコマンドを追加する

Package.jsonにJestの設定と、テストの実行コマンドを追加します。

$ vi package.json
...
  "jest": {
    "testRegex": "(/__tests__/.*|(\.|/)(test|spec))\.js$",
    "coveragePathIgnorePatterns": [
      "/node_modules/",
      "/tests/"
    ],
    "coverageThreshold": {
      "global": {
        "branches": 90,
        "functions": 90,
        "lines": 90,
        "statements": 90
      }
    },
    "rootDir": "server/"
  },
...
  "scripts": {
  ...
    "test": "jest --watchAll --coverage",
    "coverage": "jest --forceExit --coverage --coverageReporters=\"text-lcov\" > coverage.lcov",
    "test-ci":
      "yarn coverage",
  ...
  }

Jestのデフォルトのテストフォルダは「__tests__」、テストファイルのフォーマットは「∗.test.js」または「∗.spec.js」です。自分のディレクトリ構成に合わせて修正したい場合は上記のtestRegexを修正して下さい。カバレッジはcoverageThresholdで基準値を設定できます。今回は全て90%にしています。

CircleCIのファイルをを作る

CircleCIの設定ファイルは以下になります。

$ mkdir .circleci
$ touch .circleci/config.yml
$ vi .circleci/config.yml
version: 2
jobs:
  build:
    working_directory: ~/repo
    docker:
      - image: circleci/node:9.8.0
      - image: circleci/mongo:3.6.3
    steps:
      - checkout
      - restore_cache:
          keys:
          - v1-dependencies-{{ checksum "package.json" }}
          - v1-dependencies-
      - run: yarn install
      - save_cache:
          paths:
            - node_modules
          key: v1-dependencies-{{ checksum "package.json" }}
      - run:
          name: Wait for db
          command: dockerize -wait tcp://localhost:27017 -timeout 1m
      - run:
          name: Test
          command: |
            yarn test-ci

GitHubにPushする

テストを書いたら、最後にGitHubにPushします。

$ git add .
$ git commit -m 'Add CICD configs'
$ git push origin master

CircleCIでビルドおよびテストが実行され、Codecovにカバレッジが連携されれば成功です。

最後に

いかがでしたか?Jestを使って、CircleCI 2.0とCodecovでテスト実行とカバレッジ測定ができるようになりましたね。Jestは本当に使いやすいので良いですよ。それでは。

カテゴリ : 技術 Tips & Tutorials タグ : circleci, codecov, jest, nodejs

2018年6月11日 By KD コメントを書く

CircleCI 2.0でdockerizeコマンドを使用可能にする方法

CircleCI 2.0でdockerizeコマンドを使用可能にする方法

Dockerのコンテナをコントロールするのによく使われるコマンドにdokerizeがあります。CircleCI 2.0上ではデフォルトでこのコマンドは使えます。ですが、Docker Composeをそのまま使うために「machine: true」とすると使えなくなってしまいます。今回はその場合にdockerizeコマンドを有効にする方法を紹介します。

はじめに

CircleCI 2.0上で「machine: true」にした時にdockerizeコマンドを有効にするには、シンプルにインストールするしかありません。ということで、CircleCI 2.0上でdockerizeをインストールして使用可能にしましょう。

dockerizeコマンドをCircleCI 2.0に適用する

前提として、すでにCircleCI 2.0でビルドするDocker化されたアプリケーションがあるものとして、進めます。

必要なファイルを作成する

それでは、必要なファイルを作成します。

$ touch .circleci/setup-dockerize.sh
$ tree .circleci/
.circleci/
├── config.yml
└── setup-dockerize.sh

dockerizeのインストールスクリプトを書く

Dockerizeをインストールするためのスクリプトとして、「setup-dockerize.sh」は以下のようにします。

#!/bin/bash
readonly DOCKERIZE_VERSION=v0.6.1

wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
sudo rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz

バージョンなどはdockerizeのGithubを確認して下さい。

CircleCI 2.0の設定を追記する

次に、CircleCI 2.0の設定ファイル「config.yml」にdockerizeのインストールの設定を追記し、Docker化されたデータベースの起動を確認するコマンドを追加します。

version: 2
jobs:
  build:
    working_directory: ~/repo
    machine: true
    steps:
      - checkout
...(略)...
      - run:
          name: Setup dockerize
          command: bash .circleci/setup-dockerize.sh
      - run:
...(略)...
      - run:
          name: Run Docker containers
          command: yarn build && docker-compose up -d
...(略)...
      - run:
         name: Wait for db
         command: dockerize -wait tcp://localhost:27017 -timeout 1m
...(ここでテスト実行)...

今回の設定ではDocker化されたデータベースが確実に起動した状態でテストが実行可能になります。

最後に

いかがでしたか?これでCircleCI 2.0でDocker Composeを使いたい場合でもdockerizeコマンドが使えるようになったことでしょう。それでは。

カテゴリ : 技術 Tips & Tutorials タグ : circleci, docker, dockerize

  • 1
  • 2
  • 次のページ »

ブログ更新情報や海外の関連情報などを配信する無料メルマガ

Sponsored Links

About Author

KD

世界を旅し日本を愛するエンジニア。大学でコンピュータサイエンスの楽しさを学び、日本の大手IT企業で働く中で、新しい技術やスケールするビジネスが北米にある事に気づく。世界に挑戦するための最大の壁が英語であったため、フィリピン留学およびカナダ留学を経て英語を上達させた。現在は日本在住でエンジニアとして働きつつ、次の挑戦に備えて世界の動向を注視している。挑戦に終わりはない。このブログでは、エンジニアやデザイナー向けの技術情報から、海外に留学したい人向けの留学情報、海外に興味がある人向けの海外旅行情報など、有益な情報を提供しています。

https://casualdevelopers.com/

最近の投稿

  • 2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介

    2020年JS周辺のバックエンド寄りの注目技術!ネクストNodeJSの「Deno」と分散型パッケージレジストリの「Entropic」の紹介

    2020年1月13日
  • 今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~

    今さら聞けないJavaによる関数型プログラミング入門 ~ラムダ式、ストリーム、関数型インターフェース~

    2019年11月4日
  • ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~

    ReactのためのEslintおよびPrettierの設定方法 ~Airbnb JavaScript Style Guideの適用~

    2019年10月30日
  • BashからZshに移行する方法(Mac編)

    BashからZshに移行する方法(Mac編)

    2019年10月21日
  • Create React Appを使わないでゼロからReactの開発環境を構築する方法(Webpack/Docker編)

    Create React Appを使わないでゼロからReactの開発環境を構築する方法(Webpack/Docker編)

    2019年9月30日

カテゴリ

  • 技術 Tips & Tutorials (100)
  • 技術塾 (6)
  • ライフハック (26)
  • 海外留学 (12)
  • 英語学習 (3)
  • コラム (6)

アーカイブ

最高の学習のために

人気記事ランキング

  • MySQLで「ERROR 2003 (HY000): Can't connect to MySQL server」と怒られた時の対処法
    MySQLで「ERROR 2003 (HY000): Can't connect to MySQL server」と怒られた時の対処法
  • SAKURAのメールボックスで独自ドメインのメールを設定し、Gmail経由で送受信する方法
    SAKURAのメールボックスで独自ドメインのメールを設定し、Gmail経由で送受信する方法
  • バンクーバー留学豆知識:バンクーバーのATMで日本の銀行のキャッシュカードを使ってお得にお金を引き出す方法
    バンクーバー留学豆知識:バンクーバーのATMで日本の銀行のキャッシュカードを使ってお得にお金を引き出す方法
  • Jupyter Notebookで「The kernel appears to have died. It will restart automatically.」というエラーが出た場合の原因と対処法
    Jupyter Notebookで「The kernel appears to have died. It will restart automatically.」というエラーが出た場合の原因と対処法
  • Expressで「Cannot set headers after they are sent to the client」と怒られた時の対処法
    Expressで「Cannot set headers after they are sent to the client」と怒られた時の対処法
  • バンクーバー留学豆知識:日帰りでビザを切り替える方法 - フラッグポール(Flag Pole)
    バンクーバー留学豆知識:日帰りでビザを切り替える方法 - フラッグポール(Flag Pole)
  • [tips][perl] Perlで文字コードをいい感じに処理する方法
    [tips][perl] Perlで文字コードをいい感じに処理する方法
  • AWS ECRとECSの入門(EC2編) ~ ECSのEC2版を使ってReactのDockerアプリケーションをAWS上で稼働させる方法 ~
    AWS ECRとECSの入門(EC2編) ~ ECSのEC2版を使ってReactのDockerアプリケーションをAWS上で稼働させる方法 ~
  • DockerコンテナのThe PID 1 Problemとその解決策(NodeJS編)
    DockerコンテナのThe PID 1 Problemとその解決策(NodeJS編)
  • GitBookでドキュメントを作ってGithub Pagesで公開する方法
    GitBookでドキュメントを作ってGithub Pagesで公開する方法

Bitcoin寄付 / BTC Donation

Bitcoinを寄付しよう

BTC
Select Payment Method
Personal Info

Donation Total: BTC 0.0010

このブログの運営のためにBitcoinでの寄付を募集しています。お気持ち程度の寄付を頂けると管理者の励みになります。

Bitcoin寄付について知りたい方はこちらの記事へ

ビットコイン取引ならここ

  • ホーム
  • 技術 Tips & Tutorials
  • 技術塾
  • ライフハック
  • 海外留学
  • 英語学習
  • コラム
  • サイトマップ
  • タグ一覧
  • プライバシーポリシー
  • お問い合わせ

Copyright © 2022 KD - Casual Developers Notes