txgh 6.8.1 → 7.0.0.beta

data/spec/github_repo_spec.rb

@@ -1,13 +1,11 @@
 require 'spec_helper'
 
-include Txgh
-
-describe GithubRepo do
+describe Txgh::GithubRepo do
   let(:repo_name) { 'my_org/my_repo' }
   let(:branch) { 'master' }
   let(:tag) { 'tags/foo' }
   let(:api) { :api }
-  let(:repo) { GithubRepo.new(config, api) }
+  let(:repo) { described_class.new(config, api) }
   let(:diff_point) { nil }
   let(:config) do
     {
@@ -87,10 +85,6 @@ describe GithubRepo do
       expect(repo.should_process_ref?('heads/foo')).to eq(false)
     end
 
-    it 'returns true if the branch contains the special L10N text' do
-      expect(repo.should_process_ref?('heads/L10N_foo')).to eq(true)
-    end
-
     it 'returns true if the given tag matches the configured one' do
       expect(repo.should_process_ref?('tags/foo')).to eq(true)
     end
@@ -100,12 +94,12 @@ describe GithubRepo do
     end
   end
 
-  describe '#github_config_branch' do
+  describe '#git_config_branch' do
     context 'with all branches indicated' do
       let(:branch) { 'all' }
 
       it "doesn't modify the passed branch, i.e. returns 'all'" do
-        expect(repo.github_config_branch).to eq('all')
+        expect(repo.git_config_branch).to eq('all')
       end
     end
 
@@ -113,7 +107,7 @@ describe GithubRepo do
       let(:branch) { nil }
 
       it 'chooses master by default' do
-        expect(repo.github_config_branch).to eq('heads/master')
+        expect(repo.git_config_branch).to eq('heads/master')
       end
     end
 
@@ -121,17 +115,17 @@ describe GithubRepo do
       let(:branch) { 'foobar' }
 
       it 'correctly prefixes the branch' do
-        expect(repo.github_config_branch).to eq('heads/foobar')
+        expect(repo.git_config_branch).to eq('heads/foobar')
       end
     end
   end
 
-  describe '#github_config_tag' do
+  describe '#git_config_tag' do
     context 'with all tags indicated' do
       let(:tag) { 'all' }
 
       it "doesn't modify the passed tag, i.e. returns 'all'" do
-        expect(repo.github_config_tag).to eq('all')
+        expect(repo.git_config_tag).to eq('all')
       end
     end
 
@@ -139,7 +133,7 @@ describe GithubRepo do
       let(:tag) { nil }
 
       it 'returns nil' do
-        expect(repo.github_config_tag).to be_nil
+        expect(repo.git_config_tag).to be_nil
       end
     end
 
@@ -147,7 +141,7 @@ describe GithubRepo do
       let(:tag) { 'tags/foobar' }
 
       it 'leaves the prefix intact' do
-        expect(repo.github_config_tag).to eq('tags/foobar')
+        expect(repo.git_config_tag).to eq('tags/foobar')
       end
     end
   end

data/spec/github_status_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
 require 'helpers/standard_txgh_setup'
 
-include Txgh
-
-describe GithubStatus do
+describe Txgh::GithubStatus do
   include StandardTxghSetup
 
-  let(:status) { GithubStatus.new(transifex_project, github_repo, branch) }
+  let(:status) { described_class.new(transifex_project, github_repo, branch) }
   let(:resource) { tx_config.resource(resource_slug) }
   let(:branch) { 'heads/master' }
   let(:sha) { 'abc123shashasha' }
@@ -39,7 +37,7 @@ describe GithubStatus do
       it 'reports status as success' do
         expect(github_api).to receive(:create_status) do |commit_sha, state, options|
           expect(commit_sha).to eq(sha)
-          expect(state).to eq(GithubStatus::State.success)
+          expect(state).to eq(described_class::State.success)
           expect(options[:description]).to eq('Translations complete!')
           expect(options[:context]).to eq('continuous-localization/txgh')
           expect(options[:target_url]).to eq(
@@ -67,7 +65,7 @@ describe GithubStatus do
 
       it 'reports status as pending' do
         expect(github_api).to receive(:create_status) do |commit_sha, state, options|
-          expect(state).to eq(GithubStatus::State.pending)
+          expect(state).to eq(described_class::State.pending)
           expect(options[:description]).to eq('15/20 translations complete.')
         end
 
@@ -83,7 +81,7 @@ describe GithubStatus do
 
       expect(github_api).to receive(:create_status) do |commit_sha, state, options|
         expect(commit_sha).to eq(sha)
-        expect(state).to eq(GithubStatus::State.error)
+        expect(state).to eq(described_class::State.error)
         expect(options[:description]).to eq(description)
         expect(options[:context]).to eq('continuous-localization/txgh')
         expect(options[:target_url]).to eq(target_url)

data/spec/gitlab_api_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'base64'
+
+describe Txgh::GitlabApi do
+  let(:client) { double(:client) }
+  let(:api) { described_class.create_from_client(client, repo) }
+  let(:repo) { 'my_org/my_repo' }
+  let(:branch) { 'master' }
+  let(:sha) { 'abc123' }
+  let(:gitlab_response) do
+    OpenStruct.new({
+      code: 404,
+      request: double(base_uri: 'https://gitlab.com/api/v3', path: '/foo'),
+      parsed_response: Gitlab::ObjectifiedHash.new(
+        error_description: 'Displayed error_description',
+        error: 'also will not be displayed'
+      )
+    })
+  end
+
+  describe '#update_contents' do
+    let(:path) { 'path/to/file.txt' }
+    let(:old_contents) { 'abc123' }
+    let(:old_sha) { Utils.git_hash_blob(old_contents) }
+
+    it 'updates the given file contents' do
+      new_contents = 'def456'
+
+      expect(client).to(
+        receive(:get_file)
+          .with(repo, path, branch)
+          .and_return(double(content_sha256: old_sha))
+      )
+
+      expect(client).to(
+        receive(:edit_file)
+          .with(repo, path, branch, new_contents, 'message')
+      )
+
+      api.update_contents(branch, [{ path: path, contents: new_contents }], 'message')
+    end
+
+    it "doesn't update the file contents if the file hasn't changed" do
+      expect(client).to(
+        receive(:get_file)
+          .with(repo, path, branch)
+          .and_return(double(content_sha256: old_sha))
+      )
+
+      expect(client).to_not receive(:edit_file)
+
+      api.update_contents(branch, [{ path: path, contents: old_contents }], 'message')
+    end
+
+    it "creates the file if it doesn't already exist" do
+      new_contents = 'foobar'
+      expect(client).to receive(:get_file).and_raise(::Gitlab::Error::NotFound.new(gitlab_response))
+
+      expect(client).to(
+        receive(:edit_file)
+          .with(repo, path, branch, new_contents, 'message')
+      )
+
+      api.update_contents(branch, [{ path: path, contents: new_contents }], 'message')
+    end
+  end
+
+  describe '#get_ref' do
+    it 'retrieves the given ref (i.e. branch) using the client' do
+      expect(client).to receive(:commit).with(repo, sha) { double(short_id: '0') }
+      api.get_ref(sha)
+    end
+  end
+
+  describe '#download' do
+    let(:path) { 'path/to/file.xyz' }
+
+    it 'downloads the file from the given branch' do
+      expect(client).to(
+        receive(:get_file)
+          .with(repo, path, branch)
+          .and_return(double(content: 'content', encoding: 'utf-8'))
+      )
+
+      expect(api.download(path, branch)).to eq({ content: 'content' })
+    end
+
+    it 'encodes the string using the encoding specified in the response' do
+      content = 'ありがと'.encode('UTF-16')
+
+      expect(client).to(
+        receive(:get_file)
+          .with(repo, path, branch)
+          .and_return(double(content: content, encoding: 'utf-16'))
+      )
+
+      result = api.download(path, branch)
+      expect(result[:content].encoding).to eq(Encoding::UTF_16)
+      expect(result[:content]).to eq(content)
+    end
+
+    it 'automatically decodes base64-encoded content' do
+      expect(client).to(
+        receive(:get_file)
+          .with(repo, path, branch)
+          .and_return(double(content: Base64.encode64('content'), encoding: 'base64'))
+      )
+
+      expect(api.download(path, branch)).to eq({ content: 'content' })
+    end
+  end
+end

data/spec/gitlab_repo_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe Txgh::GitlabRepo do
+  let(:repo_name) { 'my_org/my_repo' }
+  let(:branch) { 'master' }
+  let(:tag) { 'tags/foo' }
+  let(:api) { :api }
+  let(:repo) { described_class.new(config, api) }
+  let(:diff_point) { nil }
+  let(:config) do
+    {
+      'name' => repo_name, 'branch' => branch, 'tag' => tag,
+      'diff_point' => diff_point
+    }
+  end
+
+  describe '#name' do
+    it 'retrieves the repo name from the config' do
+      expect(repo.name).to eq(repo_name)
+    end
+  end
+
+  describe '#branch' do
+    it 'retrieves the branch name from the config' do
+      expect(repo.branch).to eq(branch)
+    end
+  end
+
+  describe '#tag' do
+    it 'retrieves the tag name from the config' do
+      expect(repo.tag).to eq(tag)
+    end
+  end
+
+  describe '#process_all_branches?' do
+    it 'returns false if only one branch should be processed' do
+      expect(repo.process_all_branches?).to eq(false)
+    end
+
+    context 'with all branches indicated' do
+      let(:branch) { 'all' }
+
+      it 'returns true if all branches should be processed' do
+        expect(repo.process_all_branches?).to eq(true)
+      end
+    end
+  end
+
+  describe '#process_all_tags?' do
+    it 'returns false if only one tag should be processed' do
+      expect(repo.process_all_tags?).to eq(false)
+    end
+
+    context 'with all tags indicated' do
+      let(:tag) { 'all' }
+
+      it 'returns true if all tags should be processed' do
+        expect(repo.process_all_tags?).to eq(true)
+      end
+    end
+  end
+
+  describe '#should_process_ref?' do
+    context 'with all branches indicated' do
+      let(:branch) { 'all' }
+
+      it 'returns true if all branches should be processed' do
+        expect(repo.should_process_ref?('heads/foo')).to eq(true)
+      end
+    end
+
+    context 'with all tags indicated' do
+      let(:tag) { 'all' }
+
+      it 'returns true if all tags should be processed' do
+        expect(repo.should_process_ref?('tags/foo')).to eq(true)
+      end
+    end
+
+    it 'returns true if the given branch matches the configured one' do
+      expect(repo.should_process_ref?('heads/master')).to eq(true)
+    end
+
+    it "returns false if the given branch doesn't match the configured one" do
+      expect(repo.should_process_ref?('heads/foo')).to eq(false)
+    end
+
+    it 'returns true if the given tag matches the configured one' do
+      expect(repo.should_process_ref?('tags/foo')).to eq(true)
+    end
+
+    it "returns false if the given tag doesn't match the configured one" do
+      expect(repo.should_process_ref?('heads/foobar')).to eq(false)
+    end
+  end
+
+  describe '#git_config_branch' do
+    context 'with all branches indicated' do
+      let(:branch) { 'all' }
+
+      it "doesn't modify the passed branch, i.e. returns 'all'" do
+        expect(repo.git_config_branch).to eq('all')
+      end
+    end
+
+    context 'with a nil branch' do
+      let(:branch) { nil }
+
+      it 'chooses master by default' do
+        expect(repo.git_config_branch).to eq('heads/master')
+      end
+    end
+
+    context 'with a configured branch' do
+      let(:branch) { 'foobar' }
+
+      it 'correctly prefixes the branch' do
+        expect(repo.git_config_branch).to eq('heads/foobar')
+      end
+    end
+  end
+
+  describe '#git_config_tag' do
+    context 'with all tags indicated' do
+      let(:tag) { 'all' }
+
+      it "doesn't modify the passed tag, i.e. returns 'all'" do
+        expect(repo.git_config_tag).to eq('all')
+      end
+    end
+
+    context 'with a nil tag' do
+      let(:tag) { nil }
+
+      it 'returns nil' do
+        expect(repo.git_config_tag).to be_nil
+      end
+    end
+
+    context 'with a configured tag' do
+      let(:tag) { 'tags/foobar' }
+
+      it 'leaves the prefix intact' do
+        expect(repo.git_config_tag).to eq('tags/foobar')
+      end
+    end
+  end
+
+  describe '#upload_diffs?' do
+    it 'returns false by default' do
+      expect(repo.upload_diffs?).to eq(false)
+    end
+
+    context 'with a configured diff point' do
+      let(:diff_point) { 'heads/master' }
+
+      it 'returns true when a diff point is configured' do
+        expect(repo.upload_diffs?).to eq(true)
+      end
+    end
+  end
+
+  describe '#diff_point' do
+    context 'with a configured diff point' do
+      let(:diff_point) { 'heads/master' }
+
+      it 'returns the provided diff point' do
+        expect(repo.diff_point).to eq(diff_point)
+      end
+    end
+  end
+end

data/spec/gitlab_status_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'helpers/standard_txgh_setup'
+
+describe Txgh::GitlabStatus do
+  include StandardTxghSetup
+
+  let(:status) { described_class.new(transifex_project, gitlab_repo, branch) }
+  let(:resource) { tx_config.resource(resource_slug) }
+  let(:branch) { 'heads/master' }
+  let(:sha) { 'abc123shashasha' }
+
+  before(:each) do
+    allow(transifex_api).to receive(:get_resources).and_return(
+      [{ 'slug' => resource.resource_slug }]
+    )
+
+    allow(gitlab_api).to receive(:get_ref).and_return(
+      object: { sha: sha }
+    )
+  end
+
+  describe '#update' do
+    let(:stats) do
+      supported_languages.each_with_object({}) do |language, ret|
+        ret[language] = {
+          'translated_entities' => 10, 'untranslated_entities' => 0,
+          'completed' => '100%'
+        }
+      end
+    end
+
+    before(:each) do
+      allow(transifex_api).to receive(:get_stats).and_return(stats)
+    end
+
+    context 'with all resources at 100%' do
+      it 'reports status as success' do
+        expect(gitlab_api).to receive(:create_status) do |commit_sha, state, options|
+          expect(commit_sha).to eq(sha)
+          expect(state).to eq(described_class::State.success)
+          expect(options[:description]).to eq('Translations complete!')
+          expect(options[:context]).to eq('continuous-localization/txgh')
+          expect(options[:target_url]).to eq(
+            "https://www.transifex.com/#{organization}/#{project_name}/content"
+          )
+        end
+
+        status.update
+      end
+    end
+
+    context 'with one language at less than 100%' do
+      let(:stats) do
+        {
+          'pt' => {
+            'translated_entities' => 10, 'untranslated_entities' => 0,
+            'completed' => '100%'
+          },
+          'ja' => {
+            'translated_entities' => 5, 'untranslated_entities' => 5,
+            'completed' => '50%'
+          }
+        }
+      end
+
+      it 'reports status as pending' do
+        expect(gitlab_api).to receive(:create_status) do |commit_sha, state, options|
+          expect(state).to eq(described_class::State.pending)
+          expect(options[:description]).to eq('15/20 translations complete.')
+        end
+
+        status.update
+      end
+    end
+  end
+
+  describe '#error' do
+    it 'reports status as error' do
+      target_url = 'http://abc.foo.com'
+      description = 'The green albatross flitters in the moonlight'
+
+      expect(gitlab_api).to receive(:create_status) do |commit_sha, state, options|
+        expect(commit_sha).to eq(sha)
+        expect(state).to eq(described_class::State.error)
+        expect(options[:description]).to eq(description)
+        expect(options[:context]).to eq('continuous-localization/txgh')
+        expect(options[:target_url]).to eq(target_url)
+      end
+
+      status.error(target_url: target_url, description: description)
+    end
+  end
+end

data/spec/helpers/standard_txgh_setup.rb

@@ -6,11 +6,13 @@ module StandardTxghSetup
 
   let(:logger) { NilLogger.new }
   let(:github_api) { double(:github_api) }
+  let(:gitlab_api) { double(:gitlab_api) }
   let(:transifex_api) { double(:transifex_api) }
 
   let(:project_name) { 'my_awesome_project' }
   let(:resource_slug) { 'my_resource' }
-  let(:repo_name) { 'my_org/my_repo' }
+  let(:github_repo_name) { 'my_org/my_repo' }
+  let(:gitlab_repo_name) { 'my_org/gitlab_repo' }
   let(:branch) { 'master' }
   let(:tag) { 'all' }
   let(:ref) { 'heads/master' }
@@ -20,12 +22,13 @@ module StandardTxghSetup
   let(:diff_point) { nil }
   let(:organization) { 'myorg' }
   let(:commit_message_template) { nil }  # i.e. use the default
+  let(:push_translations_to) { github_repo_name }
 
   let(:project_config) do
     {
       'api_username' => 'transifex_api_username',
       'api_password' => 'transifex_api_password',
-      'push_translations_to' => repo_name,
+      'push_translations_to' => push_translations_to,
       'name' => project_name,
       'tx_config' => "raw://#{tx_config_raw}",
       'webhook_secret' => 'abc123',
@@ -35,14 +38,28 @@ module StandardTxghSetup
     }
   end
 
-  let(:repo_config) do
+  let(:github_config) do
     {
       'api_username' => 'github_api_username',
       'api_token' => 'github_api_token',
+      'git_repo_source' => 'github',
       'push_source_to' => project_name,
       'branch' => branch,
       'tag' => tag,
-      'name' => repo_name,
+      'name' => github_repo_name,
+      'webhook_secret' => 'abc123',
+      'diff_point' => diff_point,
+      'commit_message' => commit_message_template
+    }
+  end
+
+  let(:gitlab_config) do
+    {
+      'api_token' => 'gitlab_api_token',
+      'git_repo_source' => 'gitlab',
+      'push_source_to' => project_name,
+      'branch' => branch,
+      'name' => gitlab_repo_name,
       'webhook_secret' => 'abc123',
       'diff_point' => diff_point,
       'commit_message' => commit_message_template
@@ -77,7 +94,12 @@ module StandardTxghSetup
     {
       'github' => {
         'repos' => {
-          repo_name => repo_config
+          github_repo_name => github_config
+        }
+      },
+      'gitlab' => {
+        'repos' => {
+          gitlab_repo_name => gitlab_config
         }
       },
       'transifex' => {
@@ -93,6 +115,10 @@ module StandardTxghSetup
   end
 
   let(:github_repo) do
-    Txgh::GithubRepo.new(repo_config, github_api)
+    Txgh::GithubRepo.new(github_config, github_api)
+  end
+
+  let(:gitlab_repo) do
+    Txgh::GitlabRepo.new(gitlab_config, gitlab_api)
   end
 end

data/spec/merge_calculator_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
-include Txgh
-
-describe MergeCalculator do
+describe Txgh::MergeCalculator do
   def phrase(key, string)
     { 'key' => key, 'string' => string }
   end
@@ -15,11 +13,11 @@ describe MergeCalculator do
   end
 
   let(:head_contents) do
-    ResourceContents.from_phrase_list(resource, head_phrases)
+    Txgh::ResourceContents.from_phrase_list(resource, head_phrases)
   end
 
   let(:diff_point_contents) do
-    ResourceContents.from_phrase_list(resource, diff_point_phrases)
+    Txgh::ResourceContents.from_phrase_list(resource, diff_point_phrases)
   end
 
   let(:diff_hash) do
@@ -27,7 +25,7 @@ describe MergeCalculator do
   end
 
   let(:merge_result) do
-    MergeCalculator.merge(head_contents, diff_point_contents, diff_hash)
+    described_class.merge(head_contents, diff_point_contents, diff_hash)
   end
 
   context 'with phrases added to HEAD' do

data/spec/parse_config_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 require 'tempfile'
 
-include Txgh
-
 describe Txgh::ParseConfig do
   let(:contents) do
     """
@@ -16,7 +14,7 @@ describe Txgh::ParseConfig do
 
   shared_examples 'a correct config loader' do
     it 'has correctly parsed the given config' do
-      expect(config).to be_a(::ParseConfig)
+      expect(config).to be_a(described_class)
       expect(config.groups).to eq(%w(header header2))
       expect(config.params).to eq(
         'header' => { 'key' => 'val' },
@@ -27,7 +25,7 @@ describe Txgh::ParseConfig do
 
   describe '.load' do
     let(:config) do
-      Txgh::ParseConfig.load(contents)
+      described_class.load(contents)
     end
 
     it_behaves_like 'a correct config loader'
@@ -44,7 +42,7 @@ describe Txgh::ParseConfig do
     end
 
     let(:config) do
-      Txgh::ParseConfig.load_file(@file.path)
+      described_class.load_file(@file.path)
     end
 
     it_behaves_like 'a correct config loader'

data/spec/resource_committer_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper'
 require 'helpers/standard_txgh_setup'
 
-include Txgh
-
-describe ResourceCommitter do
+describe Txgh::ResourceCommitter do
   include StandardTxghSetup
 
   let(:language) { 'es' }
@@ -11,7 +9,7 @@ describe ResourceCommitter do
   let(:downloader) { instance_double(ResourceDownloader) }
   let(:file_name) { "translations/#{language}/sample.yml" }
   let(:committer) do
-    ResourceCommitter.new(transifex_project, github_repo, logger)
+    described_class.new(transifex_project, github_repo, logger)
   end
 
   let(:commit_message) do
@@ -51,7 +49,7 @@ describe ResourceCommitter do
 
         options = event[:options]
         expect(options[:project].name).to eq(project_name)
-        expect(options[:repo].name).to eq(repo_name)
+        expect(options[:repo].name).to eq(github_repo_name)
         expect(options[:branch]).to eq(branch)
         expect(options[:resource].original_resource_slug).to eq(resource_slug)
         expect(options[:language]).to eq(language)