fig 2.0.0.pre.alpha.3 → 2.0.0.pre.alpha.5

data/spec/command/publishing_spec.rb

@@ -0,0 +1,596 @@
+# coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'fig/command/package_loader'
+require 'fig/operating_system'
+require 'fig/repository'
+
+ECHO_COMMAND = Fig::OperatingSystem.windows? ? '@echo' : 'echo'
+
+describe 'Fig' do
+  describe 'publishing (without retrieval)' do
+    context 'starting with a clean home and remote repository' do
+      before(:each) do
+        clean_up_test_environment
+        set_up_test_environment
+        cleanup_home_and_remote
+      end
+
+      it 'complains when multiple assets have the same base name' do
+        input = <<-END
+          archive http://some-host/duplicate-archive.tar.gz
+          archive http://some-other-host/duplicate-archive.tar.gz
+          config default end
+        END
+
+        out, err, exit_code =
+            fig(%w<--publish foo/1.2.3>, input, :no_raise_on_error => true)
+
+        err.should =~ /multiple assets/
+        err.should =~ /duplicate-archive\.tar\.gz/
+        exit_code.should_not == 0
+      end
+
+      %w< archive resource >.each do
+        |asset_type|
+
+        it "complains when #{asset_type}s refer to a URL with a base name the same as the resources tarball" do
+          input = <<-END
+            #{asset_type} http://some-host/#{Fig::Repository::RESOURCES_FILE}
+            config default end
+          END
+
+          out, err, exit_code =
+              fig(%w<--publish foo/1.2.3>, input, :no_raise_on_error => true)
+
+          err.should =~
+            /cannot have an asset with the name "#{Regexp.escape(Fig::Repository::RESOURCES_FILE)}"/
+          exit_code.should_not == 0
+        end
+
+        it "complains when #{asset_type}s refer to non-existent local paths" do
+          out, err, exit_code =
+            fig(
+              [
+                %w<--publish foo/1.2.3>,
+                "--#{asset_type}",
+                'does not exist.zip',
+                %w<--set VARIABLE=VALUE>
+              ].flatten,
+              :no_raise_on_error => true
+            )
+
+          err.should =~ /\bcould not find file\b/i
+          err.should =~ /\bdoes not exist\b/
+          exit_code.should_not == 0
+        end
+      end
+
+      it "complains when globbing for archives picks up a file with the same as the resources tarball" do
+        IO.write(
+          "#{CURRENT_DIRECTORY}/#{Fig::Repository::RESOURCES_FILE}", ''
+        )
+
+        input = <<-END
+          archive *
+          config default end
+        END
+
+        out, err, exit_code =
+            fig(%w<--publish foo/1.2.3>, input, :no_raise_on_error => true)
+
+        err.should =~
+          /cannot have an asset with the name "#{Regexp.escape(Fig::Repository::RESOURCES_FILE)}"/
+        exit_code.should_not == 0
+      end
+
+      it 'publishes to remote repository' do
+        input = <<-END
+          config default
+            set FOO=BAR
+          end
+        END
+
+        fig(%w<--publish foo/1.2.3>, input)
+      end
+
+      it 'publishes a package named "config"' do
+        fig(%w<--publish config/1.2.3 --set VARIABLE=VALUE>)
+      end
+
+      it 'publishes a package with a "config" config' do
+        input = <<-END
+          config config
+            set FOO=BAR
+          end
+        END
+
+        fig(%w<--publish foo/1.2.3>, input)
+      end
+
+      it %q<--publish complains if local repository isn't in the expected format version> do
+        input = <<-END
+          config default
+            set FOO=BAR
+          end
+        END
+
+        set_local_repository_format_to_future_version()
+        out, err, exit_code =
+            fig(%w<--publish foo/1.2.3>, input, :no_raise_on_error => true)
+        err.should =~
+          /Local repository is in version \d+ format. This version of fig can only deal with repositories in version \d+ format\./
+        exit_code.should_not == 0
+      end
+
+      it %q<--publish-local complains if local repository isn't in the expected format version> do
+        input = <<-END
+          config default
+            set FOO=BAR
+          end
+        END
+
+        set_local_repository_format_to_future_version()
+        out, err, exit_code = fig(
+          %w<--publish-local foo/1.2.3>,
+          input,
+          :no_raise_on_error => true
+        )
+        err.should =~
+          /Local repository is in version \d+ format. This version of fig can only deal with repositories in version \d+ format\./
+        exit_code.should_not == 0
+      end
+
+      it %q<complains if remote repository isn't in the expected format version> do
+        input = <<-END
+          config default
+            set FOO=BAR
+          end
+        END
+
+        set_remote_repository_format_to_future_version()
+        out, err, exit_code =
+            fig(%w<--publish foo/1.2.3>, input, :no_raise_on_error => true)
+        err.should =~
+          /Remote repository is in version \d+ format. This version of fig can only deal with repositories in version \d+ format\./
+        exit_code.should_not == 0
+      end
+
+      describe 'overrides' do
+        before(:each) do
+          [3, 4, 5, 'command-line'].each do |point_ver|
+            fig(
+              [
+                '--publish',
+                "foo/1.2.#{point_ver}",
+                '--set',
+                "FOO=foo-v1.2.#{point_ver}"
+              ].flatten
+            )
+          end
+
+          [0,1].each do |point_ver|
+            fig(
+              [
+                '--publish',
+                "blah/2.0.#{point_ver}",
+                '--set',
+                "BLAH=bla20#{point_ver}"
+              ].flatten
+            )
+          end
+
+          input = <<-END
+            config default
+              include :nondefault
+            end
+            config nondefault
+              include foo/1.2.3
+              include blah/2.0.0
+            end
+          END
+          fig(%w<--publish bar/4.5.6>, input)
+
+          input = <<-END
+            # Multiple overrides will work for 'default', even if
+            # indirectly specified.
+            config default
+              include :nondefault
+            end
+            config nondefault
+              include foo/1.2.4
+              include blah/2.0.1
+            end
+          END
+          fig(%w<--publish baz/7.8.9>, input)
+
+          input = <<-END
+            config default
+              include foo/1.2.5
+            end
+          END
+          fig(%w<--publish cat/10.11.12>, input)
+
+          input = <<-END
+            config default
+              include bar/4.5.6
+
+              # Description of "multiple overrides" below out of date, however
+              # we need to ensure we don't break old package.fig files. Thus,
+              # we leave override statements on the same line as the include
+              # statements because overrides used to be part of include
+              # statements instead of being independent.
+
+              # Demonstrates the syntax for how a package overrides multiple
+              # dependencies (assuming the dependencies are resolved in a
+              # 'default' config section).
+              include baz/7.8.9:default override foo/1.2.3 override blah/2.0.0
+              include cat/10.11.12 override foo/1.2.3
+            end
+          END
+          fig(%w<--publish top/1>, input)
+        end
+
+        it 'work from a published .fig file' do
+          fig(%w<--update --include top/1 --get FOO>)[0].should == 'foo-v1.2.3'
+        end
+
+        it 'work from a package published based upon a command-line' do
+          fig(
+            %w<
+              command-line/some-version
+              --no-file
+              --publish
+              --include top/1
+              --override foo/1.2.command-line
+            >
+          )
+          fig(
+            %w<--no-file --include command-line/some-version --get FOO>
+          )[0].should == 'foo-v1.2.command-line'
+        end
+
+        it 'work from the command-line' do
+          fig(
+            %w<
+              --update
+              --include top/1
+              --override foo/1.2.command-line
+              --get FOO
+            >
+          )[0].should ==
+            'foo-v1.2.command-line'
+        end
+
+        it 'fail with conflicting versions' do
+          out, err, exit_code =
+            fig(
+              %w<
+                package/version
+                --no-file
+                --publish
+                --include  top/1
+                --override some-package/1.2.3
+                --override some-package/1.2.4
+              >,
+              :no_raise_on_error => true
+            )
+          err.should =~ /version conflict/i
+          err.should =~ /\bsome-package\b/
+          exit_code.should_not == 0
+        end
+      end
+
+      it 'complains if you publish without a package descriptor' do
+        out, err, exit_code = fig(%w<--publish>, :no_raise_on_error => true)
+        err.should =~ /need to specify a descriptor/i
+        exit_code.should_not == 0
+      end
+
+      it 'complains if you publish without a package version' do
+        out, err, exit_code = fig(%w<--publish foo>, :no_raise_on_error => true)
+        err.should =~ /version required/i
+        exit_code.should_not == 0
+      end
+
+      it 'refuses to overwrite existing version in remote repository without being forced' do
+        input = <<-END
+          config default
+            set FOO=SHEEP
+          end
+        END
+        fig(%w<--publish foo/1.2.3>, input)
+        fail unless File.exist? FIG_HOME + '/packages/foo/1.2.3/.fig'
+        fail unless File.exist? FIG_DOWNLOAD_DIR + '/foo/1.2.3/.fig'
+        fig(%w<--update --include foo/1.2.3 --get FOO>)[0].should == 'SHEEP'
+
+        input = <<-END
+          config default
+            set FOO=CHEESE
+          end
+        END
+        out, err, exit_code = fig(
+          %w<--publish foo/1.2.3>, input, :no_raise_on_error => true
+        )
+        exit_code.should_not == 0
+        fig(%w<--update --include foo/1.2.3 --get FOO>)[0].should == 'SHEEP'
+
+        fig(%w<--publish foo/1.2.3 --force>, input)
+        fig(%w<--update --include foo/1.2.3 --get FOO>)[0].should == 'CHEESE'
+      end
+
+      it 'refuses to publish with --file and an environment variable option' do
+        IO.write("#{CURRENT_DIRECTORY}/example.fig", '')
+
+        out, err, exit_code =
+          fig(
+            %w<foo/1.2.3 --publish --file example.fig --set VARIABLE=VALUE>,
+            :no_raise_on_error => true
+          )
+
+        exit_code.should_not == 0
+        err.should =~
+          /cannot publish based upon\s+(?=.*option)(?=.*package\s+definition)/i
+        out.should == ''
+      end
+
+      it %q<--publish-local cleans up after prior local publishes of the same package version> do
+        a_file_unpublished = "#{CURRENT_DIRECTORY}/a-file.txt"
+        IO.write(a_file_unpublished, '')
+
+        input = <<-END
+          resource a-file.txt
+
+          config default end
+        END
+
+        fig(%w<--publish-local foo/1.2.3>, input)
+
+        a_file_published = "#{FIG_HOME}/runtime/foo/1.2.3/a-file.txt"
+        fail unless File.exist? a_file_published
+
+        File.unlink a_file_unpublished
+
+        another_file_unpublished = "#{CURRENT_DIRECTORY}/another-file.txt"
+        IO.write(another_file_unpublished, '')
+
+        input = <<-END
+          resource another-file.txt
+
+          config default end
+        END
+
+        fig(%w<--publish-local foo/1.2.3>, input)
+
+        another_file_published =
+          "#{FIG_HOME}/runtime/foo/1.2.3/another-file.txt"
+        fail unless File.exist? another_file_published
+        fail if File.exist? a_file_published # This is the real test.
+      end
+
+      describe 'with both a package.fig file in the current directory and an environment variable option' do
+        before(:each) do
+          IO.write(
+            "#{CURRENT_DIRECTORY}/#{Fig::Command::PackageLoader::DEFAULT_PACKAGE_FILE}",
+            <<-END_PACKAGE_DOT_FIG
+              config default
+              end
+            END_PACKAGE_DOT_FIG
+          )
+        end
+
+        it 'refuses to publish without --no-file' do
+          out, err, exit_code =
+            fig(
+              %w<foo/1.2.3 --publish --set VARIABLE=VALUE>,
+              :no_raise_on_error => true
+            )
+
+          exit_code.should_not == 0
+          err.should =~
+            /cannot publish based upon\s+(?=.*option)(?=.*package\s+definition)/i
+          out.should == ''
+        end
+
+        it 'publishes with --no-file' do
+          fig(%w<foo/1.2.3 --publish --set VARIABLE=VALUE --no-file>)
+        end
+      end
+
+      it 'includes the publish comment specified on the command-line' do
+        # Windows get newlines in command-line wrong, so we can't test that
+        # part of the value handling there.
+        comment = Fig::OperatingSystem.windows? ? "   comment  \t" :
+          "\n  not indented  \t\n\n    indented\n\nnot indented  \n\n"
+
+        fig(
+          [
+            %w<--publish comment/1.2.3 --set VARIABLE=VALUE --publish-comment>,
+            comment
+          ]
+        )
+
+        out, * = fig(%w<--dump-package-definition-text comment/1.2.3>)
+
+        expected = Fig::OperatingSystem.windows? ? 'comment' :
+          "not indented\n#\n#     indented\n#\n# not indented"
+
+        out.should be_start_with(
+          "# #{expected}\n#\n#\n# Publishing information"
+        )
+      end
+
+      it 'includes the publish comment specified in a file' do
+        file = "#{CURRENT_DIRECTORY}/comment.txt"
+        comment = "\n  not indented  \t\n\n    indented\n\nnot indented  \n\n"
+        IO.write(file, comment)
+
+        fig(
+          [
+            %w<
+              --publish comment-from-file/1.2.3
+              --set VARIABLE=VALUE
+              --publish-comment-file
+            >,
+            file
+          ]
+        )
+
+        out, * = fig(%w<--dump-package-definition-text comment-from-file/1.2.3>)
+
+        expected = "not indented\n#\n#     indented\n#\n# not indented"
+
+        out.should be_start_with(
+          "# #{expected}\n#\n#\n# Publishing information"
+        )
+      end
+
+      it 'includes the publish comment specified in a file and on the command-line' do
+        file = "#{CURRENT_DIRECTORY}/comment.txt"
+        IO.write(file, "«comment from file»")
+
+        fig(
+          [
+            %w<
+              --publish comment-from-file-and-command-line/1.2.3
+              --set VARIABLE=VALUE
+              --publish-comment-file
+            >,
+            file,
+            '--publish-comment',
+            '«comment from command-line»'
+          ]
+        )
+
+        out, * = fig(
+          %w<
+            --dump-package-definition-text
+            comment-from-file-and-command-line/1.2.3
+          >
+        )
+
+        expected = "«comment from command-line»\n#\n# «comment from file»"
+
+        out.should be_start_with(
+          "# #{expected}\n#\n#\n# Publishing information"
+        )
+      end
+    end
+
+    context 'starting with a clean test environment' do
+      before(:each) do
+        clean_up_test_environment
+        set_up_test_environment
+      end
+
+      it 'publishes resource to remote repository' do
+        FileUtils.mkdir_p("#{CURRENT_DIRECTORY}/bin")
+        File.open("#{CURRENT_DIRECTORY}/bin/hello.bat", 'w') { |f| f << "#{ECHO_COMMAND} bar" }
+        if Fig::OperatingSystem.unix?
+          fail unless system "chmod +x #{CURRENT_DIRECTORY}/bin/hello.bat"
+        end
+        input = <<-END
+          resource bin/hello.bat
+          config default
+            append PATH=@/bin
+          end
+        END
+        fig(%w<--publish foo/1.2.3>, input)
+        fail unless File.exist? FIG_HOME + '/packages/foo/1.2.3/.fig'
+        fail unless File.exist? FIG_DOWNLOAD_DIR + '/foo/1.2.3/.fig'
+        fig(%w<--update --include foo/1.2.3 -- hello.bat>)[0].should == 'bar'
+      end
+
+      it 'publishes resource to remote repository using command line' do
+        FileUtils.mkdir_p("#{CURRENT_DIRECTORY}/bin")
+        File.open("#{CURRENT_DIRECTORY}/bin/hello.bat", 'w') { |f| f << "#{ECHO_COMMAND} bar" }
+        if Fig::OperatingSystem.unix?
+          fail unless system "chmod +x #{CURRENT_DIRECTORY}/bin/hello.bat"
+        end
+        fig(%w<--publish foo/1.2.3 --resource bin/hello.bat --append PATH=@/bin>)
+        fail unless File.exist? FIG_HOME + '/packages/foo/1.2.3/.fig'
+        fail unless File.exist? FIG_DOWNLOAD_DIR + '/foo/1.2.3/.fig'
+        fig(%w<--update --include foo/1.2.3 -- hello.bat>)[0].should == 'bar'
+      end
+
+      it 'publishes only to the local repo when told to' do
+        # This shouldn't matter because the remote repo shouldn't be looked at.
+        set_remote_repository_format_to_future_version()
+
+        FileUtils.mkdir_p("#{CURRENT_DIRECTORY}/bin")
+        File.open("#{CURRENT_DIRECTORY}/bin/hello.bat", 'w') { |f| f << "#{ECHO_COMMAND} bar" }
+        if Fig::OperatingSystem.unix?
+          fail unless system "chmod +x #{CURRENT_DIRECTORY}/bin/hello.bat"
+        end
+        fig(
+          %w<
+            --publish-local foo/1.2.3
+            --resource bin/hello.bat
+            --append PATH=@/bin
+          >
+        )
+        fail if File.exist? FIG_DOWNLOAD_DIR + '/foo/1.2.3/.fig'
+        fig(
+          %w<--update-if-missing --include foo/1.2.3 -- hello.bat>
+        )[0].should == 'bar'
+      end
+
+      it 'publishes a file containing an include statement without a version' do
+        set_up_test_environment()
+
+        input = <<-END_INPUT
+          config default
+            include foo # no version; need to be able to publish anyway. *sigh*
+          end
+        END_INPUT
+
+        out, err = fig(%w<--publish foo/1.2.3>, input)
+
+        out.should == ''
+        err.should =~
+          /No version in the package descriptor of "foo" in an include statement \(line/
+      end
+
+      it 'updates local packages if they already exist' do
+        FileUtils.mkdir_p("#{CURRENT_DIRECTORY}/bin")
+        File.open("#{CURRENT_DIRECTORY}/bin/hello.bat", 'w') { |f| f << "#{ECHO_COMMAND} sheep" }
+        if Fig::OperatingSystem.unix?
+          fail unless system "chmod +x #{CURRENT_DIRECTORY}/bin/hello.bat"
+        end
+        fig(
+          %w<
+            --publish-local foo/1.2.3
+            --resource bin/hello.bat
+            --append PATH=@/bin
+          >
+        )
+        fail if File.exist? FIG_DOWNLOAD_DIR + '/foo/1.2.3/.fig'
+        fig(
+          %w<
+            --update-if-missing
+            --include foo/1.2.3
+            -- hello.bat
+          >
+        )[0].should == 'sheep'
+
+        File.open("#{CURRENT_DIRECTORY}/bin/hello.bat", 'w') {
+          |f| f << "#{ECHO_COMMAND} cheese"
+        }
+        if Fig::OperatingSystem.unix?
+          fail unless system "chmod +x #{CURRENT_DIRECTORY}/bin/hello.bat"
+        end
+        fig(
+          %w<
+            --publish-local foo/1.2.3
+            --resource bin/hello.bat
+            --append PATH=@/bin
+          >
+        )
+        fail if File.exist? FIG_DOWNLOAD_DIR + '/foo/1.2.3/.fig'
+        fig(%w<--update-if-missing --include foo/1.2.3 -- hello.bat>)[0].should ==
+          'cheese'
+      end
+    end
+  end
+end