File 1674-dialyzer-Place-default-plt-in-XDG_CACHE_HO... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1674-dialyzer-Place-default-plt-in-XDG_CACHE_HOME.patch of Package erlang (Revision 803d29f7e9aa4c09100926e3598be691)

Currently displaying revision 803d29f7e9aa4c09100926e3598be691 , Show latest

From ac79baf66448d33bc92cb1618098d3db9f1f89d4 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Wed, 27 Oct 2021 10:22:52 +0200
Subject: [PATCH 4/7] dialyzer: Place default plt in $XDG_CACHE_HOME

---
 lib/dialyzer/doc/src/dialyzer_chapter.xml |  8 +++--
 lib/dialyzer/src/dialyzer_cl.erl          | 13 +++++++-
 lib/dialyzer/src/dialyzer_plt.erl         |  4 +--
 lib/dialyzer/test/plt_SUITE.erl           | 40 ++++++++++++++++++++---
 4 files changed, 55 insertions(+), 10 deletions(-)

diff --git a/lib/dialyzer/doc/src/dialyzer_chapter.xml b/lib/dialyzer/doc/src/dialyzer_chapter.xml
index 896705d3eb..264183fa17 100644
--- a/lib/dialyzer/doc/src/dialyzer_chapter.xml
+++ b/lib/dialyzer/doc/src/dialyzer_chapter.xml
@@ -68,9 +68,11 @@ dialyzer --build_plt --apps erts kernel stdlib mnesia</code>
 
     <p>Dialyzer looks if there is an environment variable called
       <c>DIALYZER_PLT</c> and places the PLT at this location. If no such
-      variable is set, Dialyzer places the PLT at
-      <c>$HOME/.dialyzer_plt</c>. The placement can also be specified using
-      the options <c>--plt</c> or <c>--output_plt</c>.</p>
+      variable is set, Dialyzer places the PLT in a file called .dialyzer_plt
+      in the <seeerl marker="stdlib:filename#user_cache">
+        <c>filename:basedir(user_cache, "erlang")</c></seeerl> folder.
+      The placement can also be specified using the options
+      <c>--plt</c> or <c>--output_plt</c>.</p>
 
     <p>Information can be added to an existing PLT using option
       <c>--add_to_plt</c>. If you also want to include the Erlang compiler in
diff --git a/lib/dialyzer/src/dialyzer_cl.erl b/lib/dialyzer/src/dialyzer_cl.erl
index 39c4634d74..0987de39eb 100644
--- a/lib/dialyzer/src/dialyzer_cl.erl
+++ b/lib/dialyzer/src/dialyzer_cl.erl
@@ -431,7 +431,18 @@ check_if_writable(PltFile) ->
 	true -> false;
 	false ->
 	  DirName = filename:dirname(PltFile),
-	  filelib:is_dir(DirName) andalso is_writable_file_or_dir(DirName)
+	  case filelib:is_dir(DirName) of
+            false ->
+              case filelib:ensure_dir(PltFile) of
+                ok ->
+                  io:format("  Creating ~ts as it did not exist...~n", [DirName]),
+                  true;
+                {error, _} ->
+                  false
+              end;
+            true ->
+              is_writable_file_or_dir(DirName)
+          end
       end
   end.
 
diff --git a/lib/dialyzer/src/dialyzer_plt.erl b/lib/dialyzer/src/dialyzer_plt.erl
index 8fd38a8922..acece3f9e7 100644
--- a/lib/dialyzer/src/dialyzer_plt.erl
+++ b/lib/dialyzer/src/dialyzer_plt.erl
@@ -235,8 +235,8 @@ contains_mfa(#plt{info = Info, contracts = Contracts}, MFA) ->
 get_default_plt() ->
   case os:getenv("DIALYZER_PLT") of
     false ->
-      {ok,[[HomeDir]]} = init:get_argument(home),
-      filename:join(HomeDir, ".dialyzer_plt");
+      CacheDir = filename:basedir(user_cache, "erlang"),
+      filename:join(CacheDir, ".dialyzer_plt");
     UserSpecPlt -> UserSpecPlt
   end.
 
diff --git a/lib/dialyzer/test/plt_SUITE.erl b/lib/dialyzer/test/plt_SUITE.erl
index 800f1fd307..e66e776f8d 100644
--- a/lib/dialyzer/test/plt_SUITE.erl
+++ b/lib/dialyzer/test/plt_SUITE.erl
@@ -4,18 +4,20 @@
 -module(plt_SUITE).
 
 -include_lib("common_test/include/ct.hrl").
+-include_lib("stdlib/include/assert.hrl").
 -include("dialyzer_test_constants.hrl").
 
--export([suite/0, all/0, build_plt/1, beam_tests/1, update_plt/1,
+-export([suite/0, all/0,
+         build_plt/1, beam_tests/1, update_plt/1,
          local_fun_same_as_callback/1,
          remove_plt/1, run_plt_check/1, run_succ_typings/1,
          bad_dialyzer_attr/1, merge_plts/1, bad_record_type/1,
-         letrec_rvals/1, missing_plt_file/1]).
+         letrec_rvals/1, missing_plt_file/1, build_xdg_plt/1]).
 
 suite() ->
   [{timetrap, ?plt_timeout}].
 
-all() -> [build_plt, beam_tests, update_plt, run_plt_check,
+all() -> [build_plt, build_xdg_plt, beam_tests, update_plt, run_plt_check,
           remove_plt, run_succ_typings, local_fun_same_as_callback,
           bad_dialyzer_attr, merge_plts, bad_record_type,
           letrec_rvals, missing_plt_file].
@@ -27,6 +29,36 @@ build_plt(Config) ->
     fail -> ct:fail(plt_build_fail)
   end.
 
+build_xdg_plt(Config) ->
+    TestHome = filename:join(?config(priv_dir, Config), ?FUNCTION_NAME),
+
+    %% We change the $HOME of the emulator to run this test
+    HomeEnv = case os:type() of
+                  {win32, _} ->
+                      [Drive | Path] = filename:split(TestHome),
+                      [{"APPDATA", filename:join(TestHome,"AppData")},
+                       {"HOMEDRIVE", Drive}, {"HOMEPATH", Path}];
+                  _ ->
+                      [{"HOME", TestHome}]
+              end,
+
+    {ok, Peer, Node} = ?CT_PEER(#{ env => HomeEnv }),
+
+    erpc:call(
+      Node,
+      fun() ->
+        ?assertMatch([], dialyzer:run(
+                           [{analysis_type, plt_build},
+                            {apps, [erts]}])),
+        ?assertMatch(
+           {ok,_}, file:read_file(
+                     filename:join(
+                       filename:basedir(user_cache, "erlang"),
+                       ".dialyzer_plt")))
+      end),
+
+    peer:stop(Peer).
+
 beam_tests(Config) when is_list(Config) ->
     PrivDir = ?config(priv_dir, Config),
     Plt = filename:join(PrivDir, "beam_tests.plt"),
@@ -485,7 +517,7 @@ succ(PltFile, BeamFile2) ->
                   {plts,[PltFile]},
                   {analysis_type, succ_typings}]).
 
-check(PltFile, BeamFile2) ->
+check(PltFile, _BeamFile2) ->
     dialyzer:run([{plts,[PltFile]},
                   {analysis_type, plt_check}]).
 
-- 
2.31.1

Places

File 1674-dialyzer-Place-default-plt-in-XDG_CACHE_HOME.patch of Package erlang (Revision 803d29f7e9aa4c09100926e3598be691)

Places