CA-408500: Remove ListFile with Xapi_stdext_unix.Unixext

Signed-off-by: Lin Liu <[email protected]>

Author: liulinC

ocaml/tests/test_extauth_plugin_ADwinbind.ml

@@ -505,7 +505,9 @@ let test_add_ipv4_localhost_to_hosts =
     let msg =
       Printf.sprintf "%s -> %s" (String.concat "\n" inp) (String.concat "\n" exp)
     in
-    let actual = HostsConfIPv4.join "hostname" "domain" inp in
+    let actual =
+      HostsConfIPv4.join ~name:"hostname" ~domain:"domain" ~lines:inp
+    in
     Alcotest.(check @@ list string) msg exp actual
   in
   let matrix =
@@ -537,7 +539,8 @@ let test_add_ipv4_and_ipv6_localhost_to_hosts =
       Printf.sprintf "%s -> %s" (String.concat "\n" inp) (String.concat "\n" exp)
     in
     let actual =
-      HostsConfIPv6.join "hostname" "domain" inp |> fun lines ->
+      HostsConfIPv6.join ~name:"hostname" ~domain:"domain" ~lines:inp
+      |> fun lines ->
       HostsConfIPv4.join ~name:"hostname" ~domain:"domain" ~lines
     in
     Alcotest.(check @@ list string) msg exp actual
@@ -569,7 +572,9 @@ let test_remove_ipv4_localhost_from_hosts =
     let msg =
       Printf.sprintf "%s -> %s" (String.concat "\n" inp) (String.concat "\n" exp)
     in
-    let actual = HostsConfIPv4.leave "hostname" "domain" inp in
+    let actual =
+      HostsConfIPv4.leave ~name:"hostname" ~domain:"domain" ~lines:inp
+    in
     Alcotest.(check @@ list string) msg exp actual
   in
   let matrix =

ocaml/xapi/extauth_plugin_ADwinbind.ml

@@ -815,7 +815,6 @@ let query_domain_workgroup ~domain =
   with _ -> raise (Auth_service_error (E_LOOKUP, err_msg))
 
 let config_winbind_daemon ~workgroup ~netbios_name ~domain =
-  let open Xapi_stdext_unix in
   let smb_config = "/etc/samba/smb.conf" in
   let allow_fallback =
     (*`allow kerberos auth fallback` depends on our internal samba patch,
@@ -825,42 +824,41 @@ let config_winbind_daemon ~workgroup ~netbios_name ~domain =
      * upgrade to samba packages with this capacity *)
     if !Xapi_globs.winbind_allow_kerberos_auth_fallback then "yes" else "no"
   in
-  let conf_contents =
-    match (workgroup, netbios_name, domain) with
-    | Some wkgroup, Some netbios, Some dom ->
-        [
-          "# autogenerated by xapi"
-        ; "[global]"
-        ; "kerberos method = secrets and keytab"
-        ; Printf.sprintf "realm = %s" dom
-        ; "security = ADS"
-        ; "template shell = /bin/bash"
-        ; "winbind refresh tickets = yes"
-        ; "winbind enum groups = no"
-        ; "winbind enum users = no"
-        ; "winbind scan trusted domains = yes"
-        ; "winbind use krb5 enterprise principals = yes"
-        ; Printf.sprintf "winbind cache time = %d"
-            !Xapi_globs.winbind_cache_time
-        ; Printf.sprintf "machine password timeout = 0"
-        ; Printf.sprintf "kerberos encryption types = %s"
-            (Kerberos_encryption_types.Winbind.to_string
-               !Xapi_globs.winbind_kerberos_encryption_type
-            )
-        ; Printf.sprintf "workgroup = %s" wkgroup
-        ; Printf.sprintf "netbios name = %s" netbios
-        ; "idmap config * : range = 3000000-3999999"
-        ; Printf.sprintf "idmap config %s: backend = rid" dom
-        ; Printf.sprintf "idmap config %s: range = 2000000-2999999" dom
-        ; Printf.sprintf "log level = %s" (debug_level ())
-        ; Printf.sprintf "allow kerberos auth fallback = %s" allow_fallback
-        ; "idmap config * : backend = tdb"
-        ; "" (* Empty line at the end *)
-        ]
-    | _ ->
-        ["# autogenerated by xapi"; "[global]"; "" (* Empty line at the end *)]
-  in
-  Helpers.ListFile.to_path smb_config conf_contents
+  ( match (workgroup, netbios_name, domain) with
+  | Some wkgroup, Some netbios, Some dom ->
+      [
+        "# autogenerated by xapi"
+      ; "[global]"
+      ; "kerberos method = secrets and keytab"
+      ; Printf.sprintf "realm = %s" dom
+      ; "security = ADS"
+      ; "template shell = /bin/bash"
+      ; "winbind refresh tickets = yes"
+      ; "winbind enum groups = no"
+      ; "winbind enum users = no"
+      ; "winbind scan trusted domains = yes"
+      ; "winbind use krb5 enterprise principals = yes"
+      ; Printf.sprintf "winbind cache time = %d" !Xapi_globs.winbind_cache_time
+      ; Printf.sprintf "machine password timeout = 0"
+      ; Printf.sprintf "kerberos encryption types = %s"
+          (Kerberos_encryption_types.Winbind.to_string
+             !Xapi_globs.winbind_kerberos_encryption_type
+          )
+      ; Printf.sprintf "workgroup = %s" wkgroup
+      ; Printf.sprintf "netbios name = %s" netbios
+      ; "idmap config * : range = 3000000-3999999"
+      ; Printf.sprintf "idmap config %s: backend = rid" dom
+      ; Printf.sprintf "idmap config %s: range = 2000000-2999999" dom
+      ; Printf.sprintf "log level = %s" (debug_level ())
+      ; Printf.sprintf "allow kerberos auth fallback = %s" allow_fallback
+      ; "idmap config * : backend = tdb"
+      ; "" (* Empty line at the end *)
+      ]
+  | _ ->
+      ["# autogenerated by xapi"; "[global]"; "" (* Empty line at the end *)]
+  )
+  |> String.concat "\n"
+  |> Xapi_stdext_unix.Unixext.write_string_to_file smb_config
 
 let clear_winbind_config () =
   (* Keep the winbind configuration if xapi config file specified explictly,
@@ -1198,7 +1196,6 @@ module RotateMachinePassword = struct
   let generate_krb5_tmp_config ~domain ~kdc_fqdn =
     (* Configure which server to change the password
      * https://web.mit.edu/kerberos/krb5-devel/doc/admin/conf_files/krb5_conf.html *)
-    let open Xapi_stdext_unix in
     let realm = String.uppercase_ascii domain in
     let domain_netbios =
       Wbinfo.domain_name_of ~target_name_type:NetbiosName ~from_name:domain
@@ -1212,22 +1209,21 @@ module RotateMachinePassword = struct
         []
     in
 
-    let conf_contents =
-      [
-        "# autogenerated by xapi"
-      ; "[libdefaults]"
-      ; Printf.sprintf "default_realm = %s" realm
-      ; "[realms]"
-      ; Printf.sprintf "%s={" realm
-      ; Printf.sprintf "kpasswd_server=%s" kdc_fqdn
-      ; Printf.sprintf "kdc=%s" kdc_fqdn
-      ; "}" (* include winbind generated configure if exists *)
-      ]
-      @ include_item
-      @ [""]
-      (* Empty line at the end *)
-    in
-    Helpers.ListFile.to_path tmp_krb5_conf conf_contents
+    [
+      "# autogenerated by xapi"
+    ; "[libdefaults]"
+    ; Printf.sprintf "default_realm = %s" realm
+    ; "[realms]"
+    ; Printf.sprintf "%s={" realm
+    ; Printf.sprintf "kpasswd_server=%s" kdc_fqdn
+    ; Printf.sprintf "kdc=%s" kdc_fqdn
+    ; "}" (* include winbind generated configure if exists *)
+    ]
+    @ include_item
+    @ [""]
+    (* Empty line at the end *)
+    |> String.concat "\n"
+    |> Xapi_stdext_unix.Unixext.write_string_to_file tmp_krb5_conf
 
   let clear_tmp_krb5_conf () =
     if !Xapi_globs.winbind_keep_configuration then
@@ -1354,19 +1350,23 @@ module HostsConfIPv4 = HostsConfFunc (HostsConfTagIPv4)
 module HostsConfIPv6 = HostsConfFunc (HostsConfTagIPv6)
 
 module ConfigHosts = struct
+  open Xapi_stdext_unix.Unixext
+
   let path = "/etc/hosts"
 
   let join ~name ~domain =
-    Helpers.ListFile.of_path path
-    |> HostsConfIPv4.join ~name ~domain
-    |> HostsConfIPv6.join ~name ~domain
-    |> Helpers.ListFile.to_path path
+    read_lines ~path |> fun lines ->
+    HostsConfIPv4.join ~name ~domain ~lines |> fun lines ->
+    HostsConfIPv6.join ~name ~domain ~lines
+    |> String.concat "\n"
+    |> write_string_to_file path
 
   let leave ~name ~domain =
-    Helpers.ListFile.of_path path
-    |> HostsConfIPv4.leave ~name ~domain
-    |> HostsConfIPv6.leave ~name ~domain
-    |> Helpers.ListFile.to_path path
+    read_lines ~path |> fun lines ->
+    HostsConfIPv4.leave ~name ~domain ~lines |> fun lines ->
+    HostsConfIPv6.leave ~name ~domain ~lines
+    |> String.concat "\n"
+    |> write_string_to_file path
 end
 
 let build_netbios_name ~config_params =
@@ -1729,12 +1729,12 @@ module AuthADWinbind : Auth_signature.AUTH_MODULE = struct
     let@ __context = Context.with_tracing ~__context __FUNCTION__ in
     let user = List.assoc_opt "user" config_params in
     let pass = List.assoc_opt "pass" config_params in
-    let {service_name; workgroup; netbios_name; _} =
-      get_domain_info_from_db ()
-    in
-    ( if Option.is_some netbios_name then
-        Option.get netbios_name |> fun name ->
+    let {service_name; netbios_name; _} = get_domain_info_from_db () in
+    ( match netbios_name with
+    | Some name ->
         ConfigHosts.leave ~domain:service_name ~name
+    | _ ->
+        ()
     ) ;
 
     (* Clean extauth config *)
@@ -1763,12 +1763,12 @@ module AuthADWinbind : Auth_signature.AUTH_MODULE = struct
     RotateMachinePassword.trigger_rotate ~start:5. ;
     Winbind.check_ready_to_serve ~timeout:300. ;
 
-    let {service_name; workgroup; netbios_name; _} =
-      get_domain_info_from_db ()
-    in
-    if Option.is_some netbios_name then
-      Option.get netbios_name |> fun name ->
-      ConfigHosts.join ~domain:service_name ~name
+    let {service_name; netbios_name; _} = get_domain_info_from_db () in
+    match netbios_name with
+    | Some name ->
+        ConfigHosts.join ~domain:service_name ~name
+    | _ ->
+        ()
 
   (* unit on_xapi_exit()
 

ocaml/xapi/helpers.ml

@@ -2360,26 +2360,3 @@ module AuthenticationCache = struct
           None
   end
 end
-
-module ListFile = struct
-  (* Read/Write List to/from file, line by line *)
-  let of_path path =
-    let ic = open_in path in
-    finally
-      (fun () ->
-        let rec read_lines acc =
-          try
-            let line = input_line ic in
-            read_lines (acc @ [line])
-          with End_of_file -> acc
-        in
-        read_lines []
-      )
-      (fun () -> close_in ic)
-
-  let to_path ?(perm = 0o0644) path contents =
-    String.concat "\n" contents |> fun x ->
-    Unixext.atomic_write_to_file path perm @@ fun fd ->
-    Unixext.really_write_string fd x |> ignore ;
-    Unix.fsync fd
-end