glacier: Detect when the glacier command in PATH is the wrong one, from boto, rather than from glacier-cli, and refuse to use it, since the boto program fails to fail when passed parameters it does not understand.

Remote/Glacier.hs

@@ -5,7 +5,7 @@
  - Licensed under the GNU GPL version 3 or higher.
  -}
 
-module Remote.Glacier (remote, jobList) where
+module Remote.Glacier (remote, jobList, checkSaneGlacierCommand) where
 
 import qualified Data.Map as M
 import qualified Data.Text as T
@@ -223,7 +223,9 @@ glacierParams c params = datacenter:params
 			(M.lookup "datacenter" c)
 
 glacierEnv :: RemoteConfig -> UUID -> Annex (Maybe [(String, String)])
-glacierEnv c u = go =<< getRemoteCredPairFor "glacier" c creds
+glacierEnv c u = do
+	liftIO checkSaneGlacierCommand
+	go =<< getRemoteCredPairFor "glacier" c creds
   where
 	go Nothing = return Nothing
 	go (Just (user, pass)) = do
@@ -301,3 +303,14 @@ jobList r keys = go =<< glacierEnv (config r) (uuid r)
 					| otherwise ->
 						parse c rest
 	parse c (_:rest) = parse c rest
+
+-- boto's version of glacier exits 0 when given a parameter it doesn't
+-- understand. See https://github.com/boto/boto/issues/2942
+checkSaneGlacierCommand :: IO ()
+checkSaneGlacierCommand = 
+	whenM ((Nothing /=) <$> catchMaybeIO shouldfail) $
+		error wrongcmd
+  where
+	test = proc "glacier" ["--compatibility-test-git-annex"]
+	shouldfail = withQuietOutput createProcessSuccess test
+	wrongcmd = "The glacier program in PATH seems to be from boto, not glacier-cli. Cannot use this program."

debian/changelog

@@ -1,3 +1,12 @@
+git-annex (5.20150206) UNRELEASED; urgency=medium
+
+  * glacier: Detect when the glacier command in PATH is the wrong one,
+    from boto, rather than from glacier-cli, and refuse to use it,
+    since the boto program fails to fail when passed
+    parameters it does not understand.
+
+ -- Joey Hess <id@joeyh.name>  Fri, 06 Feb 2015 13:57:08 -0400
+
 git-annex (5.20150205) unstable; urgency=medium
 
   * info: Can now display info about a given uuid.

doc/bugs/glacier_fails_to_copy.mdwn

@@ -80,3 +80,6 @@ git-annex: copy: 230 failed
 
 # End of transcript or log.
 """]]
+
+> git-annex will now detect this misconfiguration and refuse to use it, so
+> [[done]] --[[Joey]]

doc/bugs/glacier_fails_to_copy/comment_2_b0614f2e7417af733f54c9ff569b11b0._comment

@@ -0,0 +1,33 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 2"""
+ date="2015-02-06T17:30:50Z"
+ content="""
+Since someone also mentioned this problem on IRC (I don't know if it was
+you), I am wondering if this is an easy mistake to make. I guess so; you
+installed boto from Arch's packages and it included a /usr/bin/glacier..
+Same could happen if using pip to install boto, I think.
+
+I don't want to support multiple different glacier interface programs. The
+eventual plan is to move glacier support into git-annex, using a haskell
+library.
+
+The other concerning thing is that git-annex seems to have reported that
+some of the transfers succeeded. It seems, very unfortunately, that
+the glacier command from boto exits 0 when given unsupported
+parameters. So, git-annex will think a transfer succeeded, at least some of
+the time (sometimes gpg notices that the encrypted output is not all
+consumed).
+
+I think that the best fix will be to make glacier-cli install a
+"glacier-cli" program. Then git-annex can run that instead of "glacier" and
+will be much less likely to run into namespace pollution.
+
+I have filed 2 bug reports:
+
+* [boto's glacier should exit nonzero after displaying usage](https://github.com/boto/boto/issues/2942)
+* [glacier-cli should provide a glacier-cli command](https://github.com/basak/glacier-cli/issues/30)
+
+I have also put a really ugly hack into git-annex to detect when the wrong
+glacier is installed, and refuse to use it.
+"""]]