Allow user to specify a custom binary name (#349)

* Allow user to specify a custom app name

Author: kmsquire

docs/src/apps.md

@@ -168,6 +168,11 @@ multiplication, `rand(3,3) * rand(3,3)` requires both the standard libraries
 Nevertheless, the option is there to use. Just make sure to properly test the
 app with the resulting sysimage.
 
+### Custom binary name
+
+By default, the binary in the `bin` directory take the name of the project,
+as defined in `Project.toml`.  If you want to change the name, you can pass
+`app_name="some_app_name"` to `create_app`.
 
 ### Artifacts
 
@@ -252,4 +257,3 @@ CodeInfo(
 │         value@_3
 │   %11 = MyApp.DEPOT_PATH
 ```
-

src/PackageCompiler.jl

@@ -549,6 +549,9 @@ compiler.
 
 ### Keyword arguments:
 
+- `app_name::String`: an alternative name for the compiled app.  If not provided,
+   the name of the package (as specified in Project.toml) is used.
+
 - `precompile_execution_file::Union{String, Vector{String}}`: A file or list of
    files that contain code which precompilation statements should be recorded from.
 
@@ -573,6 +576,7 @@ compiler.
 """
 function create_app(package_dir::String,
                     app_dir::String;
+                    app_name=nothing,
                     precompile_execution_file::Union{String, Vector{String}}=String[],
                     precompile_statements_file::Union{String, Vector{String}}=String[],
                     incremental=false,
@@ -590,7 +594,10 @@ function create_app(package_dir::String,
     if ctx.env.pkg === nothing
         error("expected package to have a `name`-entry")
     end
-    app_name = ctx.env.pkg.name
+    sysimg_name = ctx.env.pkg.name
+    if app_name === nothing
+        app_name = sysimg_name
+    end
     sysimg_file = app_name * "." * Libdl.dlext
     if isdir(app_dir)
         if !force
@@ -621,15 +628,15 @@ function create_app(package_dir::String,
                             incremental=false, filter_stdlibs=filter_stdlibs,
                             cpu_target=cpu_target)
 
-            create_sysimage(Symbol(app_name); sysimage_path=sysimg_file, project=package_dir,
+            create_sysimage(Symbol(sysimg_name); sysimage_path=sysimg_file, project=package_dir,
                             incremental=true,
                             precompile_execution_file=precompile_execution_file,
                             precompile_statements_file=precompile_statements_file,
                             cpu_target=cpu_target,
                             base_sysimage=tmp_base_sysimage,
                             isapp=true)
         else
-            create_sysimage(Symbol(app_name); sysimage_path=sysimg_file, project=package_dir,
+            create_sysimage(Symbol(sysimg_name); sysimage_path=sysimg_file, project=package_dir,
                                               incremental=incremental, filter_stdlibs=filter_stdlibs,
                                               precompile_execution_file=precompile_execution_file,
                                               precompile_statements_file=precompile_statements_file,

test/runtests.jl

@@ -50,19 +50,22 @@ end
     for incremental in (is_slow_ci ? (false,) : (true, false))
         if incremental == false
             filter_stdlibs = (is_slow_ci ? (true, ) : (true, false))
+            binary_name_args = ("CustomName", nothing)
         else
             filter_stdlibs = (false,)
+            binary_name_args = (nothing,)
         end
-        for filter in filter_stdlibs
+        for (filter, name) in zip(filter_stdlibs, binary_name_args)
             tmp_app_source_dir = joinpath(tmp, "MyApp")
             cp(app_source_dir, tmp_app_source_dir)
             create_app(tmp_app_source_dir, app_compiled_dir; incremental=incremental, force=true, filter_stdlibs=filter,
-                       precompile_execution_file=joinpath(app_source_dir, "precompile_app.jl"))
+                       precompile_execution_file=joinpath(app_source_dir, "precompile_app.jl"), app_name=name)
             rm(tmp_app_source_dir; recursive=true)
             # Get rid of some local state
             rm(joinpath(new_depot, "packages"); recursive=true)
             rm(joinpath(new_depot, "compiled"); recursive=true)
-            app_path = abspath(app_compiled_dir, "bin", "MyApp" * (Sys.iswindows() ? ".exe" : ""))
+            app_name = name !== nothing ? name : "MyApp"
+            app_path = abspath(app_compiled_dir, "bin", app_name * (Sys.iswindows() ? ".exe" : ""))
             app_output = read(`$app_path`, String)
 
             # Check stdlib filtering