source4/torture/util.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2008
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef _TORTURE_UTIL_H_
  21 #define _TORTURE_UTIL_H_
  22
  23 #include "lib/torture/torture.h"
  24
  25 struct smbcli_state;
  26 struct smbcli_tree;
  27
  28 /**
  29  * Useful target macros for handling server bugs in torture tests.
  30  */
  31 #define TARGET_IS_WINXP(_tctx) (torture_setting_bool(_tctx, "winxp", false))
  32 #define TARGET_IS_W2K3(_tctx) (torture_setting_bool(_tctx, "w2k3", false))
  33 #define TARGET_IS_W2K8(_tctx) (torture_setting_bool(_tctx, "w2k8", false))
  34 #define TARGET_IS_WIN7(_tctx) (torture_setting_bool(_tctx, "win7", false))
  35 #define TARGET_IS_SAMBA3(_tctx) (torture_setting_bool(_tctx, "samba3", false))
  36 #define TARGET_IS_SAMBA4(_tctx) (torture_setting_bool(_tctx, "samba4", false))
  37
  38 /**
  39   setup a directory ready for a test
  40 */
  41 _PUBLIC_ bool torture_setup_dir(struct smbcli_state *cli, const char *dname);
  42 NTSTATUS create_directory_handle(struct smbcli_tree *tree, const char *dname, int *fnum);
  43
  44 /**
  45   sometimes we need a fairly complex file to work with, so we can test
  46   all possible attributes.
  47 */
  48 _PUBLIC_ int create_complex_file(struct smbcli_state *cli, TALLOC_CTX *mem_ctx, const char *fname);
  49 int create_complex_dir(struct smbcli_state *cli, TALLOC_CTX *mem_ctx, const char *dname);
  50 void *shm_setup(int size);
  51
  52 /**
  53   check that a wire string matches the flags specified
  54   not 100% accurate, but close enough for testing
  55 */
  56 bool wire_bad_flags(struct smb_wire_string *str, int flags,
  57                     struct smbcli_transport *transport);
  58 void dump_all_info(TALLOC_CTX *mem_ctx, union smb_fileinfo *finfo);
  59 void torture_all_info(struct smbcli_tree *tree, const char *fname);
  60 bool torture_set_file_attribute(struct smbcli_tree *tree, const char *fname, uint16_t attrib);
  61 NTSTATUS torture_set_sparse(struct smbcli_tree *tree, int fnum);
  62 NTSTATUS torture_check_ea(struct smbcli_state *cli,
  63                           const char *fname, const char *eaname, const char *value);
  64 _PUBLIC_ bool torture_open_connection_share(TALLOC_CTX *mem_ctx,
  65                                    struct smbcli_state **c,
  66                                    struct torture_context *tctx,
  67                                    const char *hostname,
  68                                    const char *sharename,
  69                                    struct tevent_context *ev);
  70 _PUBLIC_ bool torture_get_conn_index(int conn_index,
  71                                      TALLOC_CTX *mem_ctx,
  72                                      struct torture_context *tctx,
  73                                      char **host, char **share);
  74 _PUBLIC_ bool torture_open_connection_ev(struct smbcli_state **c,
  75                                          int conn_index,
  76                                          struct torture_context *tctx,
  77                                          struct tevent_context *ev);
  78 _PUBLIC_ bool torture_open_connection(struct smbcli_state **c, struct torture_context *tctx, int conn_index);
  79 _PUBLIC_ bool torture_close_connection(struct smbcli_state *c);
  80 _PUBLIC_ bool check_error(const char *location, struct smbcli_state *c,
  81                  uint8_t eclass, uint32_t ecode, NTSTATUS nterr);
  82 double torture_create_procs(struct torture_context *tctx,
  83                                                         bool (*fn)(struct torture_context *, struct smbcli_state *, int), bool *result);
  84 _PUBLIC_ struct torture_test *torture_suite_add_smb_multi_test(
  85                                                                         struct torture_suite *suite,
  86                                                                         const char *name,
  87                                                                         bool (*run) (struct torture_context *,
  88                                                                                                  struct smbcli_state *,
  89                                                                                                 int i));
  90 _PUBLIC_ struct torture_test *torture_suite_add_2smb_test(
  91                                                                         struct torture_suite *suite,
  92                                                                         const char *name,
  93                                                                         bool (*run) (struct torture_context *,
  94                                                                                                 struct smbcli_state *,
  95                                                                                                 struct smbcli_state *));
  96 _PUBLIC_ struct torture_test *torture_suite_add_1smb_test(
  97                                 struct torture_suite *suite,
  98                                 const char *name,
  99                                 bool (*run) (struct torture_context *, struct smbcli_state *));
 100 NTSTATUS torture_second_tcon(TALLOC_CTX *mem_ctx,
 101                              struct smbcli_session *session,
 102                              const char *sharename,
 103                              struct smbcli_tree **res);
 104
 105
 106 NTSTATUS torture_check_privilege(struct smbcli_state *cli,
 107                                  const char *sid_str,
 108                                  const char *privilege);
 109
 110 #endif /* _TORTURE_UTIL_H_ */