Ceedling

苗木

2024年10月26日? Ceedling 1.0.0 は間もなく出荷される予定です。プレリリース版は現在入手可能です。 Ceedling の再紹介とさまざまな補足リソースへのリンクについては、まったく新しい README を参照してください。 0.31.1 以降の新機能の概要と、詳細な変更ログと重大な変更のリストへのリンクについては、リリース ノートを参照してください。

Ceedling は C プロジェクト用のビルド システムで、Ruby の Rake (make 風の) ビルド システムを拡張したものです。 Ceedling はまた、CMock、Unity、および CException を統合することで、C での TDD (テスト駆動開発) を簡単にします。これら 3 つは、C 言語で優れた機能を作成する場合、これなしでは生きていけない素晴らしいオープンソース プロジェクトです。 Ceedling は、便利なプラグイン メカニズムを使用して拡張することもできます。

使用法に関するドキュメント

ドキュメントとライセンス情報は docs/ のリポジトリに存在します。

はじめる

まず、Ruby がシステムにインストールされていることを確認します (まだインストールされていない場合)。次に、コマンド プロンプトから次のようにします。

 > gem install ceedling

(シーリング開発者になる予定の人のための代替インストール)

 > git clone --recursive https://github.com/throwtheswitch/ceedling.git
> cd ceedling
> bundle install # Ensures you have all RubyGems needed
> git submodule update --init --recursive # Updates all submodules
> bundle exec rake # Run all Ceedling library tests

システムにバンドラーがインストールされていない場合、または問題が発生した場合は、バンドラーをインストールする必要がある場合があります。

 > sudo gem install bundler

バンドラーの実行中に問題が発生し、「 can't find gem bundler (>= 0.a) with executable bundle (Gem::GemNotFoundException)なメッセージが表示された場合は、別のバージョンのバンドラーをインストールする必要がある可能性があります。これについては、Gemfile.lock のバージョンを参照してください。現在の Gemfile.lock に基づく例は次のとおりです。

 > sudo gem install bundler -v 1.16.2

プロジェクトの作成

Ceedling を使用してプロジェクトを作成するのは簡単です。 ceedling にプロジェクトの名前を伝えるだけで、その名前のサブディレクトリが作成され、そこにデフォルトのディレクトリ構造と構成が設定されます。

 ceedling new YourNewProjectName

src ディレクトリと test ディレクトリにファイルを追加すると、それらはすぐにテスト ビルドの一部になります。別の構造が必要ですか?新しいパスまたはツールの要件に応じて、 project.ymlファイルの微調整をすぐに開始できます。

Ceedling の最新バージョンにいつでもアップグレードでき、それに付属するパッケージ化された Unity および CMock に自動的にアクセスできるようになります。

 gem update ceedling

ドキュメント

Ceedling を使い始めたばかりですか?プロジェクトを便利なドキュメントと一緒にインストールしたいと考えていませんか?問題ない！新しいプロジェクトを作成するときにこれを行うことができます。

 ceedling new --docs MyAwesomeProject

ツールとプロジェクトを結び付ける

Ceedling もその総力をプロジェクトに投入できます。これにより、外部の依存関係を気にせずに使用できるようになります。 gem を更新したからといって、この特定のプロジェクトで Ceedling が変更されることを心配する必要はありません。将来、Unity や CMock の変更によってビルドが壊れるのではないかと心配する必要はありません。 Ceedling をこの方法で使用したい場合は、プロジェクトの作成時にローカル コピーが必要であることを伝えます。

 ceedling new --local YourNewProjectName

これにより、Unity、CMock、および Ceedling がすべて、プロジェクトYourNewProjectName内のvendorという名前の新しいフォルダーにインストールされます。 srcとtestフォルダーを含む単純なディレクトリ構造が作成されます。

スコア！

ローカルにインストールされた Ceedling のバージョンを、後で最新の gem に合わせて強制的にアップグレードする場合は、簡単です。次のコマンドを発行するだけです。

 ceedling upgrade --local YourNewProjectName

newコマンドと同様に、プロジェクトの親ディレクトリから呼び出されます。

これが起こった場合、ローカルでの変更がすべて失われるのではないかと心配ですか? no_configs発行することで、Ceeling がプロジェクト ファイルを更新しないようにすることができます。

 ceedling upgrade --local --no_configs TheProject

Gitの統合

Git を使用していますか? new呼び出しに--gitignore追加することで、Ceedling にgitignoreファイルを自動的に作成させることができます。

テストを楽しんでください!