Merge pull request #54 from kornilova-l/end-to-end

End-to-end testing

Author: kornilova203

.travis.yml

@@ -15,3 +15,14 @@ matrix:
   - env: TEST_ENV=ubuntu-18.04-llvm-dev
   - env: TEST_ENV=ubuntu-18.04-llvm-6.0
   - env: TEST_ENV=ubuntu-18.04-llvm-5.0
+
+before_cache:
+  # See https://www.scala-sbt.org/1.0/docs/Travis-CI-with-sbt.html
+  # Tricks to avoid unnecessary cache updates
+  - find $HOME/.sbt -name "*.lock" | xargs rm
+  - find $HOME/.ivy2 -name "ivydata-*.properties" | xargs rm
+
+cache:
+  directories:
+    - $HOME/.ivy2/cache
+    - $HOME/.sbt/boot

Dockerfile

@@ -2,24 +2,31 @@ ARG UBUNTU_VERSION=18.04
 FROM ubuntu:$UBUNTU_VERSION
 
 RUN set -x \
+ && : Remove pre-bundled libunwind \
+ && find /usr -name "*libunwind*" -delete \
  && apt update \
- && apt install -y apt-transport-https gnupg2 ca-certificates \
+ && apt install -y --no-install-recommends apt-transport-https gnupg2 ca-certificates \
  && echo "deb https://dl.bintray.com/sbt/debian /" > /etc/apt/sources.list.d/sbt.list \
  && apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2EE0EA64E40A89B84B2DF73499E82A75642AC823 \
  && apt update \
- && apt install -y curl build-essential openjdk-8-jdk-headless sbt cmake make clang-format-5.0 \
+ && apt install -y --no-install-recommends \
+            g++ openjdk-8-jdk-headless sbt cmake make curl git \
+            libgc-dev libunwind8-dev libre2-dev \
  && rm -rf /var/lib/apt/lists/*
 
 ARG LLVM_VERSION=6.0
 ENV LLVM_VERSION=$LLVM_VERSION
 # LLVM dev versions do not have a "-x.y" version suffix.
 ARG LLVM_DEB_COMPONENT=-$LLVM_VERSION
 RUN set -x \
- && curl https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add - \
  && . /etc/lsb-release \
  && echo "deb https://apt.llvm.org/$DISTRIB_CODENAME/ llvm-toolchain-$DISTRIB_CODENAME$LLVM_DEB_COMPONENT main" > /etc/apt/sources.list.d/llvm.list \
+ && apt-key adv --fetch-keys https://apt.llvm.org/llvm-snapshot.gpg.key \
  && apt update \
- && apt install -y clang-$LLVM_VERSION libclang-$LLVM_VERSION-dev \
+ && apt install -y --no-install-recommends \
+            clang-$LLVM_VERSION clang-format-$LLVM_VERSION \
+            libclang-$LLVM_VERSION-dev llvm-$LLVM_VERSION-dev \
  && rm -rf /var/lib/apt/lists/*
 
+ENV PATH=$PATH:/usr/lib/llvm-$LLVM_VERSION/bin
 WORKDIR /src

bindgen/Main.cpp

@@ -30,6 +30,12 @@ int main(int argc, char *argv[]) {
     llvm::cl::opt<std::string> Package(
         "package", llvm::cl::cat(Category),
         llvm::cl::desc("Package name of generated Scala file"));
+    llvm::cl::opt<bool> NoLinkName(
+        "no-link", llvm::cl::cat(Category),
+        llvm::cl::desc("Library does not require linking"));
+    llvm::cl::opt<std::string> LinkName(
+        "link", llvm::cl::cat(Category),
+        llvm::cl::desc("Library to link with, e.g. -luv for libuv"));
     clang::tooling::CommonOptionsParser op(argc, (const char **)argv, Category);
     clang::tooling::ClangTool Tool(op.getCompilations(),
                                    op.getSourcePathList());
@@ -42,23 +48,33 @@ int main(int argc, char *argv[]) {
         return -1;
     }
 
+    auto linkName = LinkName.getValue();
+    if (linkName.empty()) {
+        linkName = libName;
+    }
+    if (NoLinkName.getValue()) {
+        linkName = "";
+    }
+
+    auto objectName = libName;
+    if (objectName == "native") {
+        /* there are at most 3 objects in the file.
+         * All of them will have distinct names. */
+        objectName = "nativeLib";
+    }
+
     auto stdhead = StdHeaders.getValue();
     if (!stdhead.empty()) {
         headerMan.LoadConfig(stdhead);
     }
 
     locations.clear();
 
-    ScalaFrontendActionFactory actionFactory(libName);
+    IR ir(libName, linkName, objectName, Package.getValue());
+    ScalaFrontendActionFactory actionFactory(ir);
 
     int result = Tool.run(&actionFactory);
 
-    IR ir = actionFactory.getIntermediateRepresentation();
-
-    if (!Package.empty()) {
-        ir.setPackageName(Package.getValue());
-    }
-
     auto printLoc = PrintHeadersLocation.getValue();
     if (printLoc) {
         for (const auto &location : locations) {

bindgen/ir/IR.cpp

@@ -1,15 +1,10 @@
 #include "IR.h"
 #include "../Utils.h"
 
-IR::IR(std::string libName) : libName(std::move(libName)) {
-    if (this->libName == "native") {
-        /* there are at most 3 objects in the file.
-         * All of them will have distinct names. */
-        libObjectName = "nativeLib";
-    } else {
-        libObjectName = this->libName;
-    }
-}
+IR::IR(std::string libName, std::string linkName, std::string objectName,
+       std::string packageName)
+    : libName(std::move(libName)), linkName(std::move(linkName)),
+      objectName(std::move(objectName)), packageName(packageName) {}
 
 void IR::addFunction(std::string name, std::vector<Parameter> parameters,
                      std::string retType, bool isVariadic) {
@@ -54,12 +49,15 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const IR &ir) {
           << "import scala.scalanative.native._\n\n";
     }
 
-    std::string libObjName = handleReservedWords(ir.libObjectName);
+    std::string objectName = handleReservedWords(ir.objectName);
 
     if (!ir.libObjEmpty()) {
-        s << "@native.link(\"" << ir.libName << "\")\n"
-          << "@native.extern\n"
-          << "object " << libObjName << " {\n";
+        if (!ir.linkName.empty()) {
+            s << "@native.link(\"" << ir.linkName << "\")\n";
+        }
+
+        s << "@native.extern\n"
+          << "object " << objectName << " {\n";
 
         for (const auto &typeDef : ir.typeDefs) {
             s << typeDef;
@@ -73,7 +71,7 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const IR &ir) {
     }
 
     if (!ir.enums.empty() || ir.hasHelperMethods()) {
-        s << "import " << libObjName << "._\n\n";
+        s << "import " << objectName << "._\n\n";
     }
 
     if (!ir.enums.empty()) {
@@ -207,10 +205,6 @@ bool IR::typeIsUsedOnlyInTypeDefs(std::string type) {
              isTypeUsed(unions, type));
 }
 
-void IR::setPackageName(std::string packageName) {
-    this->packageName = std::move(packageName);
-}
-
 void IR::setScalaNames() {
     /* Renaming according to Scala naming conventions
      * should happen here */

bindgen/ir/IR.h

@@ -11,7 +11,8 @@
  */
 class IR {
   public:
-    explicit IR(std::string libName);
+    explicit IR(std::string libName, std::string linkName,
+                std::string objectName, std::string packageName);
 
     void addFunction(std::string name, std::vector<Parameter> parameters,
                      std::string, bool isVariadic);
@@ -39,8 +40,6 @@ class IR {
 
     void generate(const std::string &excludePrefix);
 
-    void setPackageName(std::string packageName);
-
   private:
     /**
      * Generates type defs for enums, structs and unions
@@ -105,8 +104,9 @@ class IR {
 
     bool existsFunctionWithName(std::string functionName);
 
-    std::string libName;       // name of the library
-    std::string libObjectName; // name of Scala object
+    std::string libName;    // name of the library
+    std::string linkName;   // name of the library to link with
+    std::string objectName; // name of Scala object
     std::vector<Function> functions;
     std::vector<TypeDef> typeDefs;
     std::vector<Struct> structs;

bindgen/visitor/ScalaFrontendAction.cpp

@@ -1,6 +1,6 @@
 #include "ScalaFrontendAction.h"
 
-ScalaFrontendAction::ScalaFrontendAction(IR *ir) : ir(ir) {}
+ScalaFrontendAction::ScalaFrontendAction(IR &ir) : ir(ir) {}
 
 std::unique_ptr<clang::ASTConsumer>
 ScalaFrontendAction::CreateASTConsumer(clang::CompilerInstance &CI,

bindgen/visitor/ScalaFrontendAction.h

@@ -12,14 +12,14 @@
  */
 class ScalaFrontendAction : public clang::ASTFrontendAction {
   public:
-    explicit ScalaFrontendAction(IR *ir);
+    explicit ScalaFrontendAction(IR &ir);
 
     std::unique_ptr<clang::ASTConsumer>
     CreateASTConsumer(clang::CompilerInstance &CI,
                       clang::StringRef file) override;
 
   private:
-    IR *ir;
+    IR &ir;
 };
 
 #endif // SCALA_NATIVE_BINDGEN_SCALAFRONTENDACTION_H

bindgen/visitor/ScalaFrontendActionFactory.cpp

@@ -1,19 +1,13 @@
 #include "ScalaFrontendActionFactory.h"
 #include "ScalaFrontendAction.h"
 
-ScalaFrontendActionFactory::ScalaFrontendActionFactory(std::string libName)
-    : libName(libName), ir(libName) {}
+ScalaFrontendActionFactory::ScalaFrontendActionFactory(IR &ir) : ir(ir) {}
 
 clang::FrontendAction *ScalaFrontendActionFactory::create() {
     if (!ir.libObjEmpty() || ir.hasEnums()) {
         llvm::errs() << "IR is not empty. Please use new instance of "
                         "ScalaFrontendActionFactory.\n";
         llvm::errs().flush();
     }
-    return new ScalaFrontendAction(
-        &ir); // instance will be deleted by LibTooling
-}
-
-const IR &ScalaFrontendActionFactory::getIntermediateRepresentation() const {
-    return ir;
+    return new ScalaFrontendAction(ir);
 }

bindgen/visitor/ScalaFrontendActionFactory.h

@@ -13,16 +13,12 @@
 class ScalaFrontendActionFactory
     : public clang::tooling::FrontendActionFactory {
   public:
-    explicit ScalaFrontendActionFactory(std::string libName);
+    explicit ScalaFrontendActionFactory(IR &ir);
 
     clang::FrontendAction *create() override;
 
-    const IR &getIntermediateRepresentation() const;
-
   private:
-    std::string libName;
-
-    IR ir;
+    IR &ir;
 };
 
 #endif // SCALA_NATIVE_BINDGEN_SCALAFRONTENDACTIONFACTORY_H

bindgen/visitor/TreeConsumer.h

@@ -18,7 +18,7 @@ class TreeConsumer : public clang::ASTConsumer {
     clang::SourceManager &smanager;
 
   public:
-    TreeConsumer(clang::CompilerInstance *CI, IR *ir)
+    TreeConsumer(clang::CompilerInstance *CI, IR &ir)
         : visitor(CI, ir), smanager(CI->getASTContext().getSourceManager()) {}
 
     bool HandleTopLevelDecl(clang::DeclGroupRef DG) override {