Fix CI (#177)

Summary:
The OSS build needs the `thrift/` annotation tree to be visible from inside `compiler/` and `lib/`, because each is a separate Cabal package and Cabal cannot reference files outside a package's own directory. The annotation files are resolved by the literal path `thrift/annotation/...`, so the name has to be exactly that.

These symlinks can't be committed: `lib/` and `compiler/` already contain a `Thrift/` directory, and fbsource rejects paths that differ only in case, so pushrebase fails with:

```
Case conflict found: fbcode/common/hs/thrift/lib/Thrift conflicts with fbcode/common/hs/thrift/lib/thrift
```

So they are generated at build time instead, via a `symlinks` Make target that `compiler` and `thrift-hs` depend on. `ci-getdeps.yml` also invokes `make symlinks` explicitly before `cabal sdist`, since `thrift-compiler.cabal` globs `thrift/**/*.thrift` into the source distribution and CI runs `cabal sdist` directly rather than through the Makefile. The generated symlinks are added to `.gitignore`.

Pull Request resolved: #177

Reviewed By: helfper

Differential Revision: D116622224

Pulled By: CatherineGasnier

fbshipit-source-id: c9570f1126e0c96828d3f8c5f4910f542b1cbe2a

Author: simonmar

.github/workflows/ci-getdeps.yml

@@ -157,6 +157,11 @@ jobs:
         name: Generate C++ code from thrift files
         run: make thrift-cpp
 
+      # thrift-compiler.cabal globs thrift/**/*.thrift into the sdist, so this
+      # has to run before `cabal sdist`, not just before the Makefile codegen.
+      - name: Create the thrift/ symlinks
+        run: make symlinks
+
       - name: Build everything up to thrift-compiler
         run: cabal $CABAL_CONFIG_FLAGS build exe:thrift-compiler
 

.gitignore

@@ -5,6 +5,8 @@ gen-hs2/
 gen-cpp2/
 lib/gen-hs2/
 lib/if/gen-cpp2/
+lib/thrift
+compiler/thrift
 folly-clib/folly
 folly-clib/folly-clib.cabal
 folly-clib/fast_float*

Makefile

@@ -16,7 +16,17 @@ THRIFT_INCLUDE := -I $(HSTHRIFT_PREFIX)/include
 
 all:: compiler thrift-hs thrift-cpp server thrift-http
 
-compiler::
+# Cabal packages can't reference files outside their own directory, and the
+# annotation files are resolved by the literal path "thrift/annotation/...",
+# so the name has to be exactly this. Generated rather than committed because
+# lib/ and compiler/ also contain a Thrift/, and fbsource rejects paths
+# differing only in case.
+.PHONY: symlinks
+symlinks::
+	ln -sfn ../thrift lib/thrift
+	ln -sfn ../thrift compiler/thrift
+
+compiler:: symlinks
 	$(CABAL) build exe:thrift-compiler
 
 server::
@@ -30,47 +40,47 @@ thrift-http::
 
 thrift:: thrift-cpp thrift-hs
 
-thrift-hs:: compiler
+thrift-hs:: compiler symlinks
 	( \
 		THRIFT_COMPILE=$$($(CABAL) -v0 list-bin exe:thrift-compiler); \
 		(cd lib && $${THRIFT_COMPILE} --hs \
 			if/RpcOptions.thrift); \
 		(cd lib && $${THRIFT_COMPILE} --hs \
 			if/ApplicationException.thrift); \
-		$${THRIFT_COMPILE} --hs \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/thrift.thrift \
-			-o lib/test; \
-		$${THRIFT_COMPILE} --hs \
+			-o test); \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/scope.thrift \
-			-o lib/test; \
+			-o test); \
 		(cd lib && $${THRIFT_COMPILE} --hs --use-int \
 			test/if/math.thrift \
 			-o test); \
 		mkdir -p cpp-channel/test/if; \
-		$${THRIFT_COMPILE} --hs \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/thrift.thrift \
-			-o cpp-channel/test; \
-		$${THRIFT_COMPILE} --hs \
+			-o ../cpp-channel/test); \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/scope.thrift \
-			-o cpp-channel/test; \
+			-o ../cpp-channel/test); \
 		(cd lib && $${THRIFT_COMPILE} --hs --use-int \
 			test/if/math.thrift \
 			-o ../cpp-channel/test/if); \
-		$${THRIFT_COMPILE} --hs \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/thrift.thrift \
-			-o server/test; \
-		$${THRIFT_COMPILE} --hs \
+			-o ../server/test); \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/scope.thrift \
-			-o server/test; \
+			-o ../server/test); \
 		(cd lib && $${THRIFT_COMPILE} --hs --use-int \
 			test/if/math.thrift \
 			-o ../server/test); \
-		$${THRIFT_COMPILE} --hs \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/thrift.thrift \
-			-o http/test; \
-		$${THRIFT_COMPILE} --hs \
+			-o ../http/test); \
+		(cd lib && $${THRIFT_COMPILE} --hs \
 			thrift/annotation/scope.thrift \
-			-o http/test; \
+			-o ../http/test); \
 		(cd lib && $${THRIFT_COMPILE} --hs --use-int \
 			test/if/math.thrift \
 			-o ../http/test); \

compiler/thrift-compiler.cabal

@@ -19,7 +19,8 @@ extra-source-files:  test/fixtures/**/*.ast,
                      test/fixtures/gen-hs2/**/*.hs,
                      test/if/*.thrift,
                      tests/**/*.thrift,
-                     tests/**/*.hs
+                     tests/**/*.hs,
+                     thrift/**/*.thrift
 
 description:
     A compiler from the Thrift Interface Definition Language (IDL) to Haskell.