active_encode 0.6.0 → 0.7.0

data/spec/fixtures/pass_through/failed-id/error.log

@@ -0,0 +1 @@
+Some error

data/spec/fixtures/pass_through/failed-id/input_metadata

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<MediaInfo
+    xmlns="https://mediaarea.net/mediainfo"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://mediaarea.net/mediainfo https://mediaarea.net/mediainfo/mediainfo_2_0.xsd"
+    version="2.0">
+<creatingLibrary version="18.05" url="https://mediaarea.net/MediaInfo">MediaInfoLib</creatingLibrary>
+<media ref="file:///Bars_512kb.mp4">
+<track type="General">
+<VideoCount>1</VideoCount>
+<AudioCount>1</AudioCount>
+<FileExtension>mp4</FileExtension>
+<Format>MPEG-4</Format>
+<Format_Profile>Base Media</Format_Profile>
+<CodecID>isom</CodecID>
+<FileSize>24876</FileSize>
+<Duration>4.928</Duration>
+<OverallBitRate_Mode>VBR</OverallBitRate_Mode>
+<OverallBitRate>40383</OverallBitRate>
+<FrameRate>1.000</FrameRate>
+<FrameCount>1</FrameCount>
+<StreamSize>3216</StreamSize>
+<HeaderSize>3208</HeaderSize>
+<DataSize>21668</DataSize>
+<FooterSize>0</FooterSize>
+<IsStreamable>Yes</IsStreamable>
+<Title>Bars - http://www.archive.org/details/ColorBarsWTone</Title>
+<Movie>Bars - http://www.archive.org/details/ColorBarsWTone</Movie>
+<Recorded_Date>2008</Recorded_Date>
+<Encoded_Date>UTC 1970-01-01 00:00:00</Encoded_Date>
+<Tagged_Date>UTC 2008-11-23 18:44:25</Tagged_Date>
+<Encoded_Application>Lavf51.10.0</Encoded_Application>
+<Comment>license:  http://creativecommons.org/licenses/publicdomain/</Comment>
+</track>
+<track type="Video">
+<StreamOrder>0</StreamOrder>
+<ID>1</ID>
+<Format>AVC</Format>
+<Format_Profile>Baseline</Format_Profile>
+<Format_Level>1.3</Format_Level>
+<Format_Settings_CABAC>No</Format_Settings_CABAC>
+<Format_Settings_RefFrames>1</Format_Settings_RefFrames>
+<CodecID>avc1</CodecID>
+<Duration>1.000</Duration>
+<BitRate>18504</BitRate>
+<Width>360</Width>
+<Height>240</Height>
+<Stored_Width>368</Stored_Width>
+<Sampled_Width>360</Sampled_Width>
+<Sampled_Height>240</Sampled_Height>
+<PixelAspectRatio>1.000</PixelAspectRatio>
+<DisplayAspectRatio>1.500</DisplayAspectRatio>
+<Rotation>0.000</Rotation>
+<FrameRate_Mode>CFR</FrameRate_Mode>
+<FrameRate>1.000</FrameRate>
+<FrameRate_Original>0.200</FrameRate_Original>
+<FrameCount>1</FrameCount>
+<ColorSpace>YUV</ColorSpace>
+<ChromaSubsampling>4:2:0</ChromaSubsampling>
+<BitDepth>8</BitDepth>
+<ScanType>Progressive</ScanType>
+<StreamSize>2313</StreamSize>
+<Encoded_Date>UTC 1970-01-01 00:00:00</Encoded_Date>
+<Tagged_Date>UTC 1970-01-01 00:00:00</Tagged_Date>
+</track>
+<track type="Audio">
+<StreamOrder>1</StreamOrder>
+<ID>2</ID>
+<Format>AAC</Format>
+<Format_Profile>LC</Format_Profile>
+<CodecID>mp4a-40-2</CodecID>
+<Duration>4.928</Duration>
+<BitRate_Mode>VBR</BitRate_Mode>
+<BitRate>31407</BitRate>
+<Channels>2</Channels>
+<ChannelPositions>Front: L R</ChannelPositions>
+<ChannelLayout>L R</ChannelLayout>
+<SamplesPerFrame>1024</SamplesPerFrame>
+<SamplingRate>48000</SamplingRate>
+<SamplingCount>236544</SamplingCount>
+<FrameRate>46.875</FrameRate>
+<FrameCount>231</FrameCount>
+<Compression_Mode>Lossy</Compression_Mode>
+<StreamSize>19347</StreamSize>
+<StreamSize_Proportion>0.77774</StreamSize_Proportion>
+<Encoded_Date>UTC 1970-01-01 00:00:00</Encoded_Date>
+<Tagged_Date>UTC 1970-01-01 00:00:00</Tagged_Date>
+</track>
+</media>
+</MediaInfo>

data/spec/fixtures/pass_through/running-id/input_metadata

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<MediaInfo
+    xmlns="https://mediaarea.net/mediainfo"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://mediaarea.net/mediainfo https://mediaarea.net/mediainfo/mediainfo_2_0.xsd"
+    version="2.0">
+<creatingLibrary version="18.05" url="https://mediaarea.net/MediaInfo">MediaInfoLib</creatingLibrary>
+<media ref="file:///Bars_512kb.mp4">
+<track type="General">
+<VideoCount>1</VideoCount>
+<AudioCount>1</AudioCount>
+<FileExtension>mp4</FileExtension>
+<Format>MPEG-4</Format>
+<Format_Profile>Base Media</Format_Profile>
+<CodecID>isom</CodecID>
+<FileSize>24876</FileSize>
+<Duration>4.928</Duration>
+<OverallBitRate_Mode>VBR</OverallBitRate_Mode>
+<OverallBitRate>40383</OverallBitRate>
+<FrameRate>1.000</FrameRate>
+<FrameCount>1</FrameCount>
+<StreamSize>3216</StreamSize>
+<HeaderSize>3208</HeaderSize>
+<DataSize>21668</DataSize>
+<FooterSize>0</FooterSize>
+<IsStreamable>Yes</IsStreamable>
+<Title>Bars - http://www.archive.org/details/ColorBarsWTone</Title>
+<Movie>Bars - http://www.archive.org/details/ColorBarsWTone</Movie>
+<Recorded_Date>2008</Recorded_Date>
+<Encoded_Date>UTC 1970-01-01 00:00:00</Encoded_Date>
+<Tagged_Date>UTC 2008-11-23 18:44:25</Tagged_Date>
+<Encoded_Application>Lavf51.10.0</Encoded_Application>
+<Comment>license:  http://creativecommons.org/licenses/publicdomain/</Comment>
+</track>
+<track type="Video">
+<StreamOrder>0</StreamOrder>
+<ID>1</ID>
+<Format>AVC</Format>
+<Format_Profile>Baseline</Format_Profile>
+<Format_Level>1.3</Format_Level>
+<Format_Settings_CABAC>No</Format_Settings_CABAC>
+<Format_Settings_RefFrames>1</Format_Settings_RefFrames>
+<CodecID>avc1</CodecID>
+<Duration>1.000</Duration>
+<BitRate>18504</BitRate>
+<Width>360</Width>
+<Height>240</Height>
+<Stored_Width>368</Stored_Width>
+<Sampled_Width>360</Sampled_Width>
+<Sampled_Height>240</Sampled_Height>
+<PixelAspectRatio>1.000</PixelAspectRatio>
+<DisplayAspectRatio>1.500</DisplayAspectRatio>
+<Rotation>0.000</Rotation>
+<FrameRate_Mode>CFR</FrameRate_Mode>
+<FrameRate>1.000</FrameRate>
+<FrameRate_Original>0.200</FrameRate_Original>
+<FrameCount>1</FrameCount>
+<ColorSpace>YUV</ColorSpace>
+<ChromaSubsampling>4:2:0</ChromaSubsampling>
+<BitDepth>8</BitDepth>
+<ScanType>Progressive</ScanType>
+<StreamSize>2313</StreamSize>
+<Encoded_Date>UTC 1970-01-01 00:00:00</Encoded_Date>
+<Tagged_Date>UTC 1970-01-01 00:00:00</Tagged_Date>
+</track>
+<track type="Audio">
+<StreamOrder>1</StreamOrder>
+<ID>2</ID>
+<Format>AAC</Format>
+<Format_Profile>LC</Format_Profile>
+<CodecID>mp4a-40-2</CodecID>
+<Duration>4.928</Duration>
+<BitRate_Mode>VBR</BitRate_Mode>
+<BitRate>31407</BitRate>
+<Channels>2</Channels>
+<ChannelPositions>Front: L R</ChannelPositions>
+<ChannelLayout>L R</ChannelLayout>
+<SamplesPerFrame>1024</SamplesPerFrame>
+<SamplingRate>48000</SamplingRate>
+<SamplingCount>236544</SamplingCount>
+<FrameRate>46.875</FrameRate>
+<FrameCount>231</FrameCount>
+<Compression_Mode>Lossy</Compression_Mode>
+<StreamSize>19347</StreamSize>
+<StreamSize_Proportion>0.77774</StreamSize_Proportion>
+<Encoded_Date>UTC 1970-01-01 00:00:00</Encoded_Date>
+<Tagged_Date>UTC 1970-01-01 00:00:00</Tagged_Date>
+</track>
+</media>
+</MediaInfo>

data/spec/integration/ffmpeg_adapter_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require 'rails_helper'
 require 'shared_specs/engine_adapter_specs'
 
 describe ActiveEncode::EngineAdapters::FfmpegAdapter do
@@ -32,7 +32,9 @@ describe ActiveEncode::EngineAdapters::FfmpegAdapter do
   end
   let(:cancelling_job) do
     allow(Process).to receive(:kill).and_return(nil)
-    find_encode 'running-id'
+    encode = find_encode 'running-id'
+    File.write "#{work_dir}/running-id/cancelled", ""
+    encode
   end
   let(:completed_job) { find_encode "completed-id" }
   let(:failed_job) { find_encode 'failed-id' }
@@ -107,6 +109,53 @@ describe ActiveEncode::EngineAdapters::FfmpegAdapter do
         expect(nonmedia_job.percent_complete).to be 1
       end
     end
+
+    context "input filename with spaces" do
+      let(:file_with_space) { "file://" + Rails.root.join('..', 'spec', 'fixtures', 'file with space.mp4').to_s }
+      let!(:create_space_job) { ActiveEncode::Base.create(file_with_space, outputs: [{ label: "low", ffmpeg_opt: "-s 640x480", extension: 'mp4' }]) }
+      let(:find_space_job) { ActiveEncode::Base.find create_space_job.id }
+
+      it "does not have errors" do
+        sleep 2
+        expect(find_space_job.errors).to be_empty
+      end
+
+      it "has the input technical metadata in a file" do
+        expect(File.read("#{work_dir}/#{create_space_job.id}/input_metadata")).not_to be_empty
+      end
+
+      it "has the pid in a file" do
+        expect(File.read("#{work_dir}/#{create_space_job.id}/pid")).not_to be_empty
+      end
+
+      context 'when uri encoded' do
+        let(:file_with_space) { URI.encode("file://" + Rails.root.join('..', 'spec', 'fixtures', 'file with space.mp4').to_s) }
+
+        it "does not have errors" do
+          sleep 2
+          expect(find_space_job.errors).to be_empty
+        end
+
+        it "has the input technical metadata in a file" do
+          expect(File.read("#{work_dir}/#{create_space_job.id}/input_metadata")).not_to be_empty
+        end
+
+        it "has the pid in a file" do
+          expect(File.read("#{work_dir}/#{create_space_job.id}/pid")).not_to be_empty
+        end
+      end
+    end
+
+    context 'when failed' do
+      subject { created_job }
+
+      before do
+        allow_any_instance_of(Object).to receive(:`).and_raise Errno::ENOENT
+      end
+
+      it { is_expected.to be_failed }
+      its(:errors) { is_expected.not_to be_empty }
+    end
   end
 
   describe "#find" do
@@ -124,5 +173,20 @@ describe ActiveEncode::EngineAdapters::FfmpegAdapter do
       expect(Process).to receive(:kill).with('SIGTERM', running_job.input.id.to_i)
       running_job.cancel!
     end
+
+    it "does not attempt to stop a non-running encode" do
+      expect(Process).not_to receive(:kill).with('SIGTERM', completed_job.input.id.to_i)
+      completed_job.cancel!
+    end
+
+    it "raises an error if the process can not be found" do
+      expect(Process).to receive(:kill).with('SIGTERM', running_job.input.id.to_i).and_raise(Errno::ESRCH)
+      expect { running_job.cancel! }.to raise_error(ActiveEncode::NotRunningError)
+    end
+
+    it "raises an error" do
+      expect(Process).to receive(:kill).with('SIGTERM', running_job.input.id.to_i).and_raise(Errno::EPERM)
+      expect { running_job.cancel! }.to raise_error(ActiveEncode::CancelError)
+    end
   end
 end

data/spec/integration/pass_through_adapter_spec.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+require 'rails_helper'
+require 'shared_specs/engine_adapter_specs'
+
+describe ActiveEncode::EngineAdapters::PassThroughAdapter do
+  around do |example|
+    ActiveEncode::Base.engine_adapter = :pass_through
+
+    Dir.mktmpdir do |dir|
+      @dir = dir
+      example.run
+      Dir.foreach(dir) do |e|
+        next if e == "." || e == ".."
+        FileUtils.rm_rf(File.join(dir, e))
+      end
+    end
+
+    ActiveEncode::Base.engine_adapter = :test
+  end
+
+  let!(:work_dir) { stub_const "ActiveEncode::EngineAdapters::PassThroughAdapter::WORK_DIR", @dir }
+  let(:file) { "file://" + Rails.root.join('..', 'spec', 'fixtures', 'fireworks.mp4').to_s }
+  let(:low_derivative) { "file://" + Rails.root.join('..', 'spec', 'fixtures', 'fireworks.low.mp4').to_s }
+  let(:created_job) do
+    ActiveEncode::Base.create(file, outputs: [{ label: 'low', url: low_derivative }])
+  end
+  let(:running_job) do
+    created_job
+  end
+  let(:canceled_job) do
+    find_encode 'cancelled-id'
+  end
+  let(:cancelling_job) do
+    find_encode 'running-id'
+  end
+  let(:completed_job) { find_encode "completed-id" }
+  let(:failed_job) { find_encode 'failed-id' }
+  let(:completed_tech_metadata) do
+    {
+      audio_bitrate: 171_030,
+      audio_codec: 'mp4a-40-2',
+      duration: 6315.0,
+      file_size: 199_160,
+      frame_rate: 23.719,
+      height: 110.0,
+      id: "completed-id",
+      url: "/home/pdinh/Downloads/videoshort.mp4",
+      video_bitrate: 74_477,
+      video_codec: 'avc1',
+      width: 200.0
+    }
+  end
+  let(:completed_output) { [{ id: "completed-id" }] }
+  let(:failed_tech_metadata) { {} }
+
+  it_behaves_like "an ActiveEncode::EngineAdapter"
+
+  def find_encode(id)
+    # Precreate ffmpeg output directory and files
+    FileUtils.copy_entry "spec/fixtures/pass_through/#{id}", "#{work_dir}/#{id}"
+
+    # Simulate that progress is modified later than other files
+    sleep 0.1
+    FileUtils.touch Dir.glob("#{work_dir}/#{id}/*.mp4")
+    touch_fixture(id, "completed")
+    touch_fixture(id, "cancelled")
+    touch_fixture(id, "error.log")
+
+    # Stub out system calls
+    allow_any_instance_of(ActiveEncode::EngineAdapters::PassThroughAdapter).to receive(:`).and_return(1234)
+
+    ActiveEncode::Base.find(id)
+  end
+
+  def touch_fixture(id, filename)
+    FileUtils.touch("#{work_dir}/#{id}/#{filename}") if File.exist? "#{work_dir}/#{id}/#{filename}"
+  end
+
+  describe "#create" do
+    subject { created_job }
+
+    it "creates a directory whose name is the encode id" do
+      expect(File).to exist("#{work_dir}/#{subject.id}")
+    end
+
+    context "input file exists" do
+      it "has the input technical metadata in a file" do
+        expect(File.read("#{work_dir}/#{subject.id}/input_metadata")).not_to be_empty
+      end
+    end
+
+    context "input file doesn't exist" do
+      let(:missing_file) { "file:///a_bogus_file.mp4" }
+      let(:missing_job) { ActiveEncode::Base.create(missing_file, outputs: [{ label: "low", url: 'mp4' }]) }
+
+      it "returns the encode with correct error" do
+        expect(missing_job.errors).to include("#{missing_file} does not exist or is not accessible")
+        expect(missing_job.percent_complete).to be 1
+      end
+    end
+
+    context "input file is not media" do
+      let(:nonmedia_file) { "file://" + Rails.root.join('Gemfile').to_s }
+      let(:nonmedia_job) { ActiveEncode::Base.create(nonmedia_file, outputs: [{ label: "low", url: nonmedia_file }]) }
+
+      it "returns the encode with correct error" do
+        expect(nonmedia_job.errors).to include("Error inspecting input: #{nonmedia_file}")
+        expect(nonmedia_job.percent_complete).to be 1
+      end
+    end
+
+    context "input filename with spaces" do
+      let(:file_with_space) { "file://" + Rails.root.join('..', 'spec', 'fixtures', 'file with space.mp4').to_s }
+      let(:file_with_space_derivative) { "file://" + Rails.root.join('..', 'spec', 'fixtures', 'file with space.low.mp4').to_s }
+      let!(:create_space_job) { ActiveEncode::Base.create(file_with_space, outputs: [{ label: "low", url: file_with_space_derivative }]) }
+      let(:find_space_job) { ActiveEncode::Base.find create_space_job.id }
+
+      it "does not have errors" do
+        expect(find_space_job.errors).to be_empty
+      end
+
+      it "has the input technical metadata in a file" do
+        expect(File.read("#{work_dir}/#{create_space_job.id}/input_metadata")).not_to be_empty
+      end
+
+      context 'when uri encoded' do
+        let(:file_with_space) { URI.encode("file://" + Rails.root.join('..', 'spec', 'fixtures', 'file with space.mp4').to_s) }
+        let(:file_with_space_derivative) { URI.encode("file://" + Rails.root.join('..', 'spec', 'fixtures', 'file with space.low.mp4').to_s) }
+
+        it "does not have errors" do
+          expect(find_space_job.errors).to be_empty
+        end
+
+        it "has the input technical metadata in a file" do
+          expect(File.read("#{work_dir}/#{create_space_job.id}/input_metadata")).not_to be_empty
+        end
+      end
+    end
+
+    context 'when failed' do
+      subject { created_job }
+
+      before do
+        allow_any_instance_of(Object).to receive(:`).and_raise Errno::ENOENT
+      end
+
+      it { is_expected.to be_failed }
+      its(:errors) { is_expected.not_to be_empty }
+    end
+  end
+end

data/spec/shared_specs/engine_adapter_specs.rb

@@ -50,12 +50,12 @@ RSpec.shared_examples 'an ActiveEncode::EngineAdapter' do |*_flags|
       it 'returns an ActiveEncode::Base object' do
         expect(subject.class).to be ActiveEncode::Base
       end
-      its(:id) { is_expected.to eq 'running-id' }
+      its(:id) { is_expected.to be_present }
       it { is_expected.to be_running }
       its(:percent_complete) { is_expected.to be > 0 }
       its(:errors) { is_expected.to be_empty }
       its(:created_at) { is_expected.to be_kind_of Time }
-      its(:updated_at) { is_expected.to be > subject.created_at }
+      its(:updated_at) { is_expected.to be >= subject.created_at }
 
       it 'input is a valid ActiveEncode::Input object' do
         expect(subject.input).to be_a ActiveEncode::Input
@@ -77,7 +77,7 @@ RSpec.shared_examples 'an ActiveEncode::EngineAdapter' do |*_flags|
       it 'returns an ActiveEncode::Base object' do
         expect(subject.class).to be ActiveEncode::Base
       end
-      its(:id) { is_expected.to eq 'cancelled-id' }
+      its(:id) { is_expected.to be_present }
       it { is_expected.to be_cancelled }
       its(:percent_complete) { is_expected.to be > 0 }
       its(:errors) { is_expected.to be_empty }
@@ -104,7 +104,7 @@ RSpec.shared_examples 'an ActiveEncode::EngineAdapter' do |*_flags|
       it 'returns an ActiveEncode::Base object' do
         expect(subject.class).to be ActiveEncode::Base
       end
-      its(:id) { is_expected.to eq 'completed-id' }
+      its(:id) { is_expected.to be_present }
       it { is_expected.to be_completed }
       its(:percent_complete) { is_expected.to eq 100 }
       its(:errors) { is_expected.to be_empty }
@@ -142,7 +142,7 @@ RSpec.shared_examples 'an ActiveEncode::EngineAdapter' do |*_flags|
       it 'returns an ActiveEncode::Base object' do
         expect(subject.class).to be ActiveEncode::Base
       end
-      its(:id) { is_expected.to eq 'failed-id' }
+      its(:id) { is_expected.to be_present }
       it { is_expected.to be_failed }
       its(:percent_complete) { is_expected.to be > 0 }
       its(:errors) { is_expected.not_to be_empty }
@@ -201,12 +201,11 @@ RSpec.shared_examples 'an ActiveEncode::EngineAdapter' do |*_flags|
     it 'returns an ActiveEncode::Base object' do
       expect(subject.class).to be ActiveEncode::Base
     end
-    its(:id) { is_expected.to eq 'running-id' }
-    it { is_expected.to be_running }
+    its(:id) { is_expected.to be_present }
     its(:percent_complete) { is_expected.to be > 0 }
     its(:errors) { is_expected.to be_empty }
     its(:created_at) { is_expected.to be_kind_of Time }
-    its(:updated_at) { is_expected.to be > subject.created_at }
+    its(:updated_at) { is_expected.to be >= subject.created_at }
 
     it 'input is a valid ActiveEncode::Input object' do
       expect(subject.input).to be_a ActiveEncode::Input