fluentd-ui 0.3.13 → 0.3.14

data/app/models/fluentd/agent/td_agent.rb

@@ -16,6 +16,10 @@ class Fluentd
         `/usr/sbin/td-agent --version`.strip
       end
 
+      def dryrun!(file_path = nil)
+        exec_dryrun("/usr/sbin/td-agent", file_path)
+      end
+
       case FluentdUI.platform
       when :macosx
         include Macosx

data/app/models/fluentd/agent/td_agent/macosx.rb

@@ -16,10 +16,6 @@ class Fluentd
           dryrun && stop && start
         end
 
-        def dryrun
-          detached_command("/usr/sbin/td-agent --dry-run -q --use-v1-config -c #{config_file}")
-        end
-
         private
 
         def plist

data/app/models/fluentd/agent/td_agent/unix.rb

@@ -17,10 +17,6 @@ class Fluentd
           # https://github.com/treasure-data/td-agent/blob/master/debian/td-agent.init#L156
           detached_command('/etc/init.d/td-agent restart')
         end
-
-        def dryrun
-          detached_command('/etc/init.d/td-agent configtest')
-        end
       end
     end
   end

data/app/views/fluentd/settings/edit.html.haml

@@ -1,10 +1,8 @@
 - page_title t('.page_title', label: @fluentd.label)
 
-- if @error
-  %pre.alert.alert-danger= @error
-
 = form_tag(daemon_setting_path(@fluentd), method: :patch) do
   .form-group
     = text_area_tag "config", @config, class: "form-control", rows: 40, class: "js-fluentd-config-editor"
   %p.text.text-danger= t('terms.notice_restart_for_config_edit', brand: fluentd_ui_brand)
   = submit_tag t("terms.update"), class: "btn btn-primary"
+  = submit_tag t("terms.configtest"), class: "btn btn-default", name: "dryrun"

data/app/views/fluentd/settings/histories/show.html.haml

@@ -15,7 +15,17 @@
 
 .row
   .col-xs-12
+    %h2
+      ="#{t('.target_config')}(#{params[:id]})"
     %pre
       = preserve do
         = @backup_file.content
 
+  .col-xs-12.diff
+    %h2
+      Diff:
+    %div
+      = t(".diff_description", file_name: params[:id] )
+      .pull-right
+        = link_to t(".show_current"), daemon_setting_path(@fluentd)
+    = preserve render "/shared/settings/diff"

data/app/views/fluentd/settings/running_backup/show.html.haml

@@ -12,9 +12,20 @@
 .row
   .col-xs-12
     - if @backup_file.content
+      %h2
+        = t('.page_title')
       %pre
         = preserve do
           = @backup_file.content
     - else
       %p
         =t('fluentd.common.never_started_yet', brand: fluentd_ui_brand)
+  - if @backup_file.content
+    .col-xs-12.diff
+      %h2
+        Diff:
+      %div
+        = t(".diff_description")
+        .pull-right
+          = link_to t(".show_current"), daemon_setting_path(@fluentd)
+      = preserve render "/shared/settings/diff"

data/app/views/shared/settings/_diff.html.erb

@@ -0,0 +1,21 @@
+<% if @changed %>
+  <pre>
+  <% @sdiff.each do |diff| %>
+  <% case diff.action %>
+  <% when "=" %>
+  <span class="stay"><%= diff.new_element %></span>
+  <% when "!" %>
+  <span class="deleted">- <%= diff.old_element %></span>
+  <span class="added">+ <%= diff.new_element %></span>
+  <% when "-" %>
+  <span class="deleted">- <%= diff.old_element %></span>
+  <% when "+" %>
+  <span class="added">+ <%= diff.new_element %></span>
+  <% end %>
+  <% end %>
+  </pre>
+<% else %>
+  <div class="frame-corner-radius">
+   <%= t('messages.no_diff') %>
+  </div>
+<% end %>

data/circle.yml

@@ -6,3 +6,8 @@ checkout:
   post:
     - mkdir -p tmp
     - sync
+
+dependencies:
+  pre:
+    - wget http://packages.treasuredata.com.s3.amazonaws.com/2/ubuntu/precise/pool/contrib/t/td-agent/td-agent_2.1.3-0_amd64.deb
+    - sudo dpkg -i td-agent_2.1.3-0_amd64.deb

data/config/application.rb

@@ -20,6 +20,7 @@ require "sucker_punch"
 require "settingslogic"
 require "kramdown-haml"
 require "jbuilder"
+require "diff/lcs"
 
 module FluentdUi
   class Application < Rails::Application

data/config/locales/translation_en.yml

@@ -14,6 +14,7 @@ en:
     config_successfully_copied: "Config has been copied successfully. Please restart %{brand} to use the new config"
     note_updating_success: "Note successfully updated."
     dryrun_is_passed: config test passed
+    no_diff: There is no difference in files.
 
   terms: &terms
     name: Name
@@ -261,10 +262,16 @@ en:
           page_title: "Setting Histories"
         show:
           page_title: "Reuse Setting History"
+          target_config: "Target Config"
+          current_config: "Current Config"
+          diff_description: "diff between current config and target config(%{file_name}) (showing with '+' and '-' if any)"
+          show_current: "> see current config"
       running_backup:
         title: "Running Config"
         show:
           page_title: "Running Config"
+          diff_description: "diff between config and running config (showing with '+' and '-' if any)"
+          show_current: "> see current config"
 
   misc:
     information:

data/config/locales/translation_ja.yml

@@ -14,6 +14,7 @@ ja:
     config_successfully_copied: "設定をコピーしました。反映させるには、 %{brand}を再起動してください。"
     note_updating_success: "メモを更新しました。"
     dryrun_is_passed: この設定でのdry-runが成功しました
+    no_diff: ファイル間の差異はありません。
 
   terms: &terms
     name: アカウント名
@@ -266,10 +267,16 @@ ja:
           page_title: "設定履歴 | 一覧"
         show:
           page_title: "設定履歴 | 詳細"
+          target_config: "対象設定"
+          current_config: "現在の設定"
+          diff_description: "現在の設定と対象設定(%{file_name})の差分(+-で表示)"
+          show_current: "> 現在の設定を見る"
       running_backup:
         title: "使用中の設定"
         show:
           page_title: "使用中の設定"
+          diff_description: "現在の設定と使用中の設定の差分(+-で表示)"
+          show_current: "> 現在の設定を見る"
 
   misc:
     information:

data/fluentd-ui.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "kramdown", "> 1.0.0"
   spec.add_dependency "kramdown-haml"
   spec.add_dependency "rubyzip", "~> 1.1" # API changed as Zip::ZipFile -> Zip::File since v1.0.0
+  spec.add_dependency "diff-lcs"
 end

data/lib/fluentd-ui.rb

@@ -21,7 +21,11 @@ module FluentdUI
   end
 
   def self.data_dir
-    dir = ENV["FLUENTD_UI_DATA_DIR"].presence || ENV["HOME"] + "/.fluentd-ui/core_data"
+    if Rails.env.test?
+      dir = Rails.root.join("tmp", "core_data").to_s
+    else
+      dir = ENV["FLUENTD_UI_DATA_DIR"].presence || ENV["HOME"] + "/.fluentd-ui/core_data"
+    end
     FileUtils.mkdir_p(dir) # ensure directory exists
     dir
   end

data/lib/fluentd-ui/version.rb

@@ -1,3 +1,3 @@
 module FluentdUI
-  VERSION = "0.3.13"
+  VERSION = "0.3.14"
 end

data/spec/features/fluentd/setting/histories_spec.rb

@@ -26,7 +26,8 @@ describe "histories", stub: :daemon do
   end
 
   describe 'show' do
-    let(:last_backup_file) { Fluentd::SettingArchive::BackupFile.new(daemon.agent.backup_files_in_new_order.first) }
+    let!(:last_backup_file) { Fluentd::SettingArchive::BackupFile.new(daemon.agent.backup_files_in_new_order.first) }
+    let!(:new_file) { Fluentd::SettingArchive::BackupFile.new(daemon.agent.backup_files_in_new_order[1]) }
 
     before do
       visit "/daemon/setting/histories/#{last_backup_file.file_id}"
@@ -37,6 +38,27 @@ describe "histories", stub: :daemon do
       page.should have_text(last_backup_file.content)
     end
 
+    describe 'diff' do
+      context 'has diff' do
+        it 'shows diff between current and target' do
+          page.should have_text("-   type http")
+          page.should have_text("+   type forward")
+          page.should have_text("-   port 8899")
+          page.should have_text("+   port 24224")
+        end
+      end
+
+      context 'has no diff' do
+        before do
+          visit "/daemon/setting/histories/#{new_file.file_id}"
+        end
+
+        it 'shows no diff message' do
+          page.should have_text(I18n.t('messages.no_diff'))
+        end
+      end
+    end
+
     it 'update config and redirect to setting#show' do
       click_link I18n.t("terms.reuse")
 

data/spec/features/fluentd/setting/running_backup_spec.rb

@@ -8,7 +8,7 @@ describe "running_backup", stub: :daemon do
     login_with exists_user
   end
 
-  context 'has running backup file' do
+  context 'has no running backup file' do
     before do
       visit '/daemon/setting/running_backup'
     end
@@ -36,6 +36,27 @@ describe "running_backup", stub: :daemon do
         expect(page).to have_text(I18n.t("terms.reuse"))
       end
 
+      describe 'diff' do
+        context 'has diff' do
+          it 'shows diff between current and running' do
+            expect(page).to have_text("-   type http")
+            expect(page).to have_text("-   port 8899")
+            expect(page).to have_text("+   Running backup file content")
+          end
+        end
+
+        context 'has no diff' do
+          before do
+            daemon.agent.config_write backup_content
+            visit '/daemon/setting/running_backup'
+          end
+
+          it 'shows no diff message' do
+            page.should have_text(I18n.t('messages.no_diff'))
+          end
+        end
+      end
+
       it 'update config and redirect to setting#show' do
         click_link I18n.t("terms.reuse")
 

data/spec/models/fluentd/agent/local_common_spec.rb

@@ -47,9 +47,11 @@ describe 'Fluentd::Agent::LocalCommon' do
     CONF
 
     before do
+      # other specs could be write in this dir, so clean that in `before`
+      FileUtils.rm_r daemon.agent.config_backup_dir, force: true
       ::Settings.max_backup_files_count.times do |i|
-        backpued_time = now - (i + 1).hours
-        FileUtils.touch File.join(daemon.agent.config_backup_dir , "#{backpued_time.strftime('%Y%m%d_%H%M%S')}.conf")
+        backuped_time = now - (i + 1).hours
+        FileUtils.touch File.join(daemon.agent.config_backup_dir , "#{backuped_time.strftime('%Y%m%d_%H%M%S')}.conf")
       end
 
       daemon.agent.config_write config_contents #add before conf

data/spec/models/fluentd/agent_spec.rb

@@ -96,32 +96,9 @@ describe Fluentd::Agent do
     describe "#restart" do
       it_should_behave_like "Restart strategy"
     end
-
-    describe "#dryrun" do
-      subject { instance.dryrun }
-
-      describe "valid/invalid" do
-        before { instance.stub(:system).and_return(ret) }
-
-        context "valid config" do
-          let(:ret) { true }
-          it { should be_truthy }
-        end
-
-        context "invalid config" do
-          let(:ret) { false }
-          it { should be_falsy }
-        end
-      end
-
-      it "invoke #system" do
-        instance.should_receive(:system).with(/--dry-run/)
-        subject
-      end
-    end
   end
 
-  describe "TdAgent" do
+  describe "TdAgent", td_agent_required: true do
     let(:described_class) { Fluentd::Agent::TdAgent } # override nested described_class behavior as https://github.com/rspec/rspec-core/issues/1114
 
     it_should_behave_like "Fluentd::Agent has common behavior"
@@ -153,30 +130,6 @@ describe Fluentd::Agent do
         expect(File.read(backup_file)).to eq File.read(instance.config_file)
       end
     end
-
-    describe "#dryrun" do
-      subject { instance.dryrun }
-
-      describe "valid/invalid" do
-        before { instance.stub(:detached_command).and_return(ret) }
-
-        context "valid config" do
-          let(:ret) { true }
-          it { should be_truthy }
-        end
-
-        context "invalid config" do
-          let(:ret) { false }
-          it { should be_falsy }
-        end
-      end
-
-      it "invoke #system" do
-        # --dry-run check on Mac, configtest for Unix
-        instance.should_receive(:detached_command).with(/(--dry-run|configtest)/)
-        subject
-      end
-    end
   end
 end
 

data/spec/models/plugin_spec.rb

@@ -38,7 +38,7 @@ describe Plugin do
         it { should_not be_valid }
       end
 
-      context "somthing filled is valid" do
+      context "something filled is valid" do
         let(:gem_name) { "foobar" }
         it { should be_valid }
       end
@@ -53,7 +53,7 @@ describe Plugin do
         it { should_not be_valid }
       end
 
-      context "somthing filled is valid" do
+      context "something filled is valid" do
         let(:version) { "0.0.1" }
         it { should be_valid }
       end

data/spec/spec_helper.rb

@@ -61,4 +61,14 @@ RSpec.configure do |config|
 
   # rspec 2.99
   config.infer_spec_type_from_file_location!
+
+  unless File.directory?("/opt/td-agent")
+    # including td-agent specific tests, so some tests will fail if the system has no td-agent
+    warn "\n\nSkipping td-agent specific tests (system has no td-agent)\n\n"
+    config.filter_run_excluding :td_agent_required => true
+  end
+
+  config.after(:suite) do
+    FileUtils.rm_rf FluentdUI.data_dir
+  end
 end

data/spec/support/fluentd_agent_common_behavior.rb

@@ -124,5 +124,58 @@ shared_examples_for "Fluentd::Agent has common behavior" do |klass|
       end
     end
   end
+
+  describe "#dryrun" do
+    let(:root) { FluentdUI.data_dir + "/tmp/agentspec/" }
+    let(:dummy_log_file) { root + "dummy.log" }
+    let(:dummy_pid_file) { root + "dummy.pid" }
+
+    before do
+      FileUtils.mkdir_p root
+      instance.stub(:log_file).and_return(dummy_log_file)
+      instance.stub(:pid_file).and_return(dummy_pid_file)
+    end
+
+    describe "valid/invalid" do
+      let(:config_path) { Rails.root.join("tmp", "fluent-test.conf").to_s }
+      before { File.write(config_path, config) }
+      after { File.unlink(config_path) }
+
+      context "valid config" do
+        let(:config) { <<-CONF.strip_heredoc }
+        <source>
+          type forward
+        </source>
+        CONF
+
+        context "with `!`" do
+          subject { instance.dryrun!(config_path) }
+          it { expect { subject }.to_not raise_error }
+        end
+
+        context "without `!`" do
+          subject { instance.dryrun(config_path) }
+          it { should be_truthy }
+        end
+      end
+
+      context "invalid config" do
+        let(:config) { <<-CONF.strip_heredoc }
+        <source>
+          type forward
+        CONF
+
+        context "with `!`" do
+          subject { instance.dryrun!(config_path) }
+          it { expect { subject }.to raise_error(Fluentd::Agent::ConfigError) }
+        end
+
+        context "without `!`" do
+          subject { instance.dryrun(config_path) }
+          it { should be_falsy }
+        end
+      end
+    end
+  end
 end