api_test.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  1. package api_test
  2. import (
  3. "bytes"
  4. "encoding/json"
  5. "fmt"
  6. "net"
  7. "net/http"
  8. "net/http/httptest"
  9. "os"
  10. "path/filepath"
  11. "runtime"
  12. "strconv"
  13. "testing"
  14. "time"
  15. "github.com/go-chi/render"
  16. _ "github.com/go-sql-driver/mysql"
  17. _ "github.com/lib/pq"
  18. _ "github.com/mattn/go-sqlite3"
  19. "github.com/rs/zerolog"
  20. "github.com/drakkan/sftpgo/api"
  21. "github.com/drakkan/sftpgo/config"
  22. "github.com/drakkan/sftpgo/dataprovider"
  23. "github.com/drakkan/sftpgo/logger"
  24. "github.com/drakkan/sftpgo/sftpd"
  25. )
  26. const (
  27. defaultUsername = "test_user"
  28. defaultPassword = "test_password"
  29. testPubKey = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC03jj0D+djk7pxIf/0OhrxrchJTRZklofJ1NoIu4752Sq02mdXmarMVsqJ1cAjV5LBVy3D1F5U6XW4rppkXeVtd04Pxb09ehtH0pRRPaoHHlALiJt8CoMpbKYMA8b3KXPPriGxgGomvtU2T2RMURSwOZbMtpsugfjYSWenyYX+VORYhylWnSXL961LTyC21ehd6d6QnW9G7E5hYMITMY9TuQZz3bROYzXiTsgN0+g6Hn7exFQp50p45StUMfV/SftCMdCxlxuyGny2CrN/vfjO7xxOo2uv7q1qm10Q46KPWJQv+pgZ/OfL+EDjy07n5QVSKHlbx+2nT4Q0EgOSQaCTYwn3YjtABfIxWwgAFdyj6YlPulCL22qU4MYhDcA6PSBwDdf8hvxBfvsiHdM+JcSHvv8/VeJhk6CmnZxGY0fxBupov27z3yEO8nAg8k+6PaUiW1MSUfuGMF/ktB8LOstXsEPXSszuyXiOv4DaryOXUiSn7bmRqKcEFlJusO6aZP0= nicola@p1"
  30. logSender = "APITesting"
  31. userPath = "/api/v1/user"
  32. activeConnectionsPath = "/api/v1/sftp_connection"
  33. quotaScanPath = "/api/v1/quota_scan"
  34. )
  35. var (
  36. defaultPerms = []string{dataprovider.PermAny}
  37. homeBasePath string
  38. testServer *httptest.Server
  39. )
  40. func TestMain(m *testing.M) {
  41. if runtime.GOOS == "windows" {
  42. homeBasePath = "C:\\"
  43. } else {
  44. homeBasePath = "/tmp"
  45. }
  46. configDir := ".."
  47. logfilePath := filepath.Join(configDir, "sftpgo_api_test.log")
  48. confName := "sftpgo.conf"
  49. logger.InitLogger(logfilePath, 5, 1, 28, false, zerolog.DebugLevel)
  50. configFilePath := filepath.Join(configDir, confName)
  51. config.LoadConfig(configFilePath)
  52. providerConf := config.GetProviderConf()
  53. err := dataprovider.Initialize(providerConf, configDir)
  54. if err != nil {
  55. logger.Warn(logSender, "error initializing data provider: %v", err)
  56. os.Exit(1)
  57. }
  58. dataProvider := dataprovider.GetProvider()
  59. httpdConf := config.GetHTTPDConfig()
  60. router := api.GetHTTPRouter()
  61. httpdConf.BindPort = 8081
  62. api.SetBaseURL("http://127.0.0.1:8081")
  63. sftpd.SetDataProvider(dataProvider)
  64. api.SetDataProvider(dataProvider)
  65. go func() {
  66. logger.Debug(logSender, "initializing HTTP server with config %+v", httpdConf)
  67. s := &http.Server{
  68. Addr: fmt.Sprintf("%s:%d", httpdConf.BindAddress, httpdConf.BindPort),
  69. Handler: router,
  70. ReadTimeout: 300 * time.Second,
  71. WriteTimeout: 300 * time.Second,
  72. MaxHeaderBytes: 1 << 20, // 1MB
  73. }
  74. if err := s.ListenAndServe(); err != nil {
  75. logger.Error(logSender, "could not start HTTP server: %v", err)
  76. }
  77. }()
  78. testServer = httptest.NewServer(api.GetHTTPRouter())
  79. defer testServer.Close()
  80. waitTCPListening(fmt.Sprintf("%s:%d", httpdConf.BindAddress, httpdConf.BindPort))
  81. exitCode := m.Run()
  82. os.Remove(logfilePath)
  83. os.Exit(exitCode)
  84. }
  85. func TestBasicUserHandling(t *testing.T) {
  86. user, err := api.AddUser(getTestUser(), http.StatusOK)
  87. if err != nil {
  88. t.Errorf("unable to add user: %v", err)
  89. }
  90. user.MaxSessions = 10
  91. user.QuotaSize = 4096
  92. user.QuotaFiles = 2
  93. user.UploadBandwidth = 128
  94. user.DownloadBandwidth = 64
  95. user, err = api.UpdateUser(user, http.StatusOK)
  96. if err != nil {
  97. t.Errorf("unable to update user: %v", err)
  98. }
  99. users, err := api.GetUsers(0, 0, defaultUsername, http.StatusOK)
  100. if err != nil {
  101. t.Errorf("unable to get users: %v", err)
  102. }
  103. if len(users) != 1 {
  104. t.Errorf("number of users mismatch, expected: 1, actual: %v", len(users))
  105. }
  106. err = api.RemoveUser(user, http.StatusOK)
  107. if err != nil {
  108. t.Errorf("unable to remove: %v", err)
  109. }
  110. }
  111. func TestAddUserNoCredentials(t *testing.T) {
  112. u := getTestUser()
  113. u.Password = ""
  114. u.PublicKey = ""
  115. _, err := api.AddUser(u, http.StatusBadRequest)
  116. if err != nil {
  117. t.Errorf("unexpected error adding user with no credentials: %v", err)
  118. }
  119. }
  120. func TestAddUserNoUsername(t *testing.T) {
  121. u := getTestUser()
  122. u.Username = ""
  123. _, err := api.AddUser(u, http.StatusBadRequest)
  124. if err != nil {
  125. t.Errorf("unexpected error adding user with no home dir: %v", err)
  126. }
  127. }
  128. func TestAddUserNoHomeDir(t *testing.T) {
  129. u := getTestUser()
  130. u.HomeDir = ""
  131. _, err := api.AddUser(u, http.StatusBadRequest)
  132. if err != nil {
  133. t.Errorf("unexpected error adding user with no home dir: %v", err)
  134. }
  135. }
  136. func TestAddUserInvalidHomeDir(t *testing.T) {
  137. u := getTestUser()
  138. u.HomeDir = "relative_path"
  139. _, err := api.AddUser(u, http.StatusBadRequest)
  140. if err != nil {
  141. t.Errorf("unexpected error adding user with invalid home dir: %v", err)
  142. }
  143. }
  144. func TestAddUserNoPerms(t *testing.T) {
  145. u := getTestUser()
  146. u.Permissions = []string{}
  147. _, err := api.AddUser(u, http.StatusBadRequest)
  148. if err != nil {
  149. t.Errorf("unexpected error adding user with no perms: %v", err)
  150. }
  151. }
  152. func TestAddUserInvalidPerms(t *testing.T) {
  153. u := getTestUser()
  154. u.Permissions = []string{"invalidPerm"}
  155. _, err := api.AddUser(u, http.StatusBadRequest)
  156. if err != nil {
  157. t.Errorf("unexpected error adding user with no perms: %v", err)
  158. }
  159. }
  160. func TestUpdateUser(t *testing.T) {
  161. user, err := api.AddUser(getTestUser(), http.StatusOK)
  162. if err != nil {
  163. t.Errorf("unable to add user: %v", err)
  164. }
  165. user.HomeDir = filepath.Join(homeBasePath, "testmod")
  166. user.UID = 33
  167. user.GID = 101
  168. user.MaxSessions = 10
  169. user.QuotaSize = 4096
  170. user.QuotaFiles = 2
  171. user.Permissions = []string{dataprovider.PermCreateDirs, dataprovider.PermDelete, dataprovider.PermDownload}
  172. user.UploadBandwidth = 1024
  173. user.DownloadBandwidth = 512
  174. user, err = api.UpdateUser(user, http.StatusOK)
  175. if err != nil {
  176. t.Errorf("unable to update user: %v", err)
  177. }
  178. err = api.RemoveUser(user, http.StatusOK)
  179. if err != nil {
  180. t.Errorf("unable to remove: %v", err)
  181. }
  182. }
  183. func TestUpdateUserNoCredentials(t *testing.T) {
  184. user, err := api.AddUser(getTestUser(), http.StatusOK)
  185. if err != nil {
  186. t.Errorf("unable to add user: %v", err)
  187. }
  188. user.Password = ""
  189. user.PublicKey = ""
  190. // password and public key will be omitted from json serialization if empty and so they will remain unchanged
  191. // and no validation error will be raised
  192. _, err = api.UpdateUser(user, http.StatusOK)
  193. if err != nil {
  194. t.Errorf("unexpected error updating user with no credentials: %v", err)
  195. }
  196. err = api.RemoveUser(user, http.StatusOK)
  197. if err != nil {
  198. t.Errorf("unable to remove: %v", err)
  199. }
  200. }
  201. func TestUpdateUserEmptyHomeDir(t *testing.T) {
  202. user, err := api.AddUser(getTestUser(), http.StatusOK)
  203. if err != nil {
  204. t.Errorf("unable to add user: %v", err)
  205. }
  206. user.HomeDir = ""
  207. _, err = api.UpdateUser(user, http.StatusBadRequest)
  208. if err != nil {
  209. t.Errorf("unexpected error updating user with empty home dir: %v", err)
  210. }
  211. err = api.RemoveUser(user, http.StatusOK)
  212. if err != nil {
  213. t.Errorf("unable to remove: %v", err)
  214. }
  215. }
  216. func TestUpdateUserInvalidHomeDir(t *testing.T) {
  217. user, err := api.AddUser(getTestUser(), http.StatusOK)
  218. if err != nil {
  219. t.Errorf("unable to add user: %v", err)
  220. }
  221. user.HomeDir = "relative_path"
  222. _, err = api.UpdateUser(user, http.StatusBadRequest)
  223. if err != nil {
  224. t.Errorf("unexpected error updating user with empty home dir: %v", err)
  225. }
  226. err = api.RemoveUser(user, http.StatusOK)
  227. if err != nil {
  228. t.Errorf("unable to remove: %v", err)
  229. }
  230. }
  231. func TestUpdateNonExistentUser(t *testing.T) {
  232. _, err := api.UpdateUser(getTestUser(), http.StatusNotFound)
  233. if err != nil {
  234. t.Errorf("unable to update user: %v", err)
  235. }
  236. }
  237. func TestGetNonExistentUser(t *testing.T) {
  238. _, err := api.GetUserByID(0, http.StatusNotFound)
  239. if err != nil {
  240. t.Errorf("unable to get user: %v", err)
  241. }
  242. }
  243. func TestDeleteNonExistentUser(t *testing.T) {
  244. err := api.RemoveUser(getTestUser(), http.StatusNotFound)
  245. if err != nil {
  246. t.Errorf("unable to remove user: %v", err)
  247. }
  248. }
  249. func TestAddDuplicateUser(t *testing.T) {
  250. user, err := api.AddUser(getTestUser(), http.StatusOK)
  251. if err != nil {
  252. t.Errorf("unable to add user: %v", err)
  253. }
  254. _, err = api.AddUser(getTestUser(), http.StatusInternalServerError)
  255. if err != nil {
  256. t.Errorf("unable to add second user: %v", err)
  257. }
  258. err = api.RemoveUser(user, http.StatusOK)
  259. if err != nil {
  260. t.Errorf("unable to remove user: %v", err)
  261. }
  262. }
  263. func TestGetUsers(t *testing.T) {
  264. user1, err := api.AddUser(getTestUser(), http.StatusOK)
  265. if err != nil {
  266. t.Errorf("unable to add user: %v", err)
  267. }
  268. u := getTestUser()
  269. u.Username = defaultUsername + "1"
  270. user2, err := api.AddUser(u, http.StatusOK)
  271. if err != nil {
  272. t.Errorf("unable to add second user: %v", err)
  273. }
  274. users, err := api.GetUsers(0, 0, "", http.StatusOK)
  275. if err != nil {
  276. t.Errorf("unable to get users: %v", err)
  277. }
  278. if len(users) < 2 {
  279. t.Errorf("at least 2 users are expected")
  280. }
  281. users, err = api.GetUsers(1, 0, "", http.StatusOK)
  282. if err != nil {
  283. t.Errorf("unable to get users: %v", err)
  284. }
  285. if len(users) != 1 {
  286. t.Errorf("1 user is expected")
  287. }
  288. users, err = api.GetUsers(1, 1, "", http.StatusOK)
  289. if err != nil {
  290. t.Errorf("unable to get users: %v", err)
  291. }
  292. if len(users) != 1 {
  293. t.Errorf("1 user is expected")
  294. }
  295. err = api.RemoveUser(user1, http.StatusOK)
  296. if err != nil {
  297. t.Errorf("unable to remove user: %v", err)
  298. }
  299. err = api.RemoveUser(user2, http.StatusOK)
  300. if err != nil {
  301. t.Errorf("unable to remove user: %v", err)
  302. }
  303. }
  304. func TestGetQuotaScans(t *testing.T) {
  305. _, err := api.GetQuotaScans(http.StatusOK)
  306. if err != nil {
  307. t.Errorf("unable to get quota scans: %v", err)
  308. }
  309. }
  310. func TestStartQuotaScan(t *testing.T) {
  311. user, err := api.AddUser(getTestUser(), http.StatusOK)
  312. if err != nil {
  313. t.Errorf("unable to add user: %v", err)
  314. }
  315. err = api.StartQuotaScan(user, http.StatusCreated)
  316. if err != nil {
  317. t.Errorf("unable to start quota scan: %v", err)
  318. }
  319. err = api.RemoveUser(user, http.StatusOK)
  320. if err != nil {
  321. t.Errorf("unable to remove user: %v", err)
  322. }
  323. }
  324. // test using mock http server
  325. func TestBasicUserHandlingMock(t *testing.T) {
  326. user := getTestUser()
  327. userAsJSON := getUserAsJSON(t, user)
  328. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  329. rr := executeRequest(req)
  330. checkResponseCode(t, http.StatusOK, rr.Code)
  331. err := render.DecodeJSON(rr.Body, &user)
  332. if err != nil {
  333. t.Errorf("Error get user: %v", err)
  334. }
  335. req, _ = http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  336. rr = executeRequest(req)
  337. checkResponseCode(t, http.StatusInternalServerError, rr.Code)
  338. user.MaxSessions = 10
  339. user.UploadBandwidth = 128
  340. userAsJSON = getUserAsJSON(t, user)
  341. req, _ = http.NewRequest(http.MethodPut, userPath+"/"+strconv.FormatInt(user.ID, 10), bytes.NewBuffer(userAsJSON))
  342. rr = executeRequest(req)
  343. checkResponseCode(t, http.StatusOK, rr.Code)
  344. req, _ = http.NewRequest(http.MethodGet, userPath+"/"+strconv.FormatInt(user.ID, 10), nil)
  345. rr = executeRequest(req)
  346. checkResponseCode(t, http.StatusOK, rr.Code)
  347. var updatedUser dataprovider.User
  348. err = render.DecodeJSON(rr.Body, &updatedUser)
  349. if err != nil {
  350. t.Errorf("Error decoding updated user: %v", err)
  351. }
  352. if user.MaxSessions != updatedUser.MaxSessions || user.UploadBandwidth != updatedUser.UploadBandwidth {
  353. t.Errorf("Error modifying user actual: %v, %v", updatedUser.MaxSessions, updatedUser.UploadBandwidth)
  354. }
  355. req, _ = http.NewRequest(http.MethodDelete, userPath+"/"+strconv.FormatInt(user.ID, 10), nil)
  356. rr = executeRequest(req)
  357. checkResponseCode(t, http.StatusOK, rr.Code)
  358. }
  359. func TestGetUserByIdInvalidParamsMock(t *testing.T) {
  360. req, _ := http.NewRequest(http.MethodGet, userPath+"/0", nil)
  361. rr := executeRequest(req)
  362. checkResponseCode(t, http.StatusNotFound, rr.Code)
  363. req, _ = http.NewRequest(http.MethodGet, userPath+"/a", nil)
  364. rr = executeRequest(req)
  365. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  366. }
  367. func TestAddUserNoUsernameMock(t *testing.T) {
  368. user := getTestUser()
  369. user.Username = ""
  370. userAsJSON := getUserAsJSON(t, user)
  371. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  372. rr := executeRequest(req)
  373. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  374. }
  375. func TestAddUserInvalidHomeDirMock(t *testing.T) {
  376. user := getTestUser()
  377. user.HomeDir = "relative_path"
  378. userAsJSON := getUserAsJSON(t, user)
  379. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  380. rr := executeRequest(req)
  381. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  382. }
  383. func TestAddUserInvalidPermsMock(t *testing.T) {
  384. user := getTestUser()
  385. user.Permissions = []string{}
  386. userAsJSON := getUserAsJSON(t, user)
  387. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  388. rr := executeRequest(req)
  389. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  390. }
  391. func TestAddUserInvalidJsonMock(t *testing.T) {
  392. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer([]byte("invalid json")))
  393. rr := executeRequest(req)
  394. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  395. }
  396. func TestUpdateUserInvalidJsonMock(t *testing.T) {
  397. user := getTestUser()
  398. userAsJSON := getUserAsJSON(t, user)
  399. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  400. rr := executeRequest(req)
  401. checkResponseCode(t, http.StatusOK, rr.Code)
  402. err := render.DecodeJSON(rr.Body, &user)
  403. if err != nil {
  404. t.Errorf("Error get user: %v", err)
  405. }
  406. req, _ = http.NewRequest(http.MethodPut, userPath+"/"+strconv.FormatInt(user.ID, 10), bytes.NewBuffer([]byte("Invalid json")))
  407. rr = executeRequest(req)
  408. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  409. req, _ = http.NewRequest(http.MethodDelete, userPath+"/"+strconv.FormatInt(user.ID, 10), nil)
  410. rr = executeRequest(req)
  411. checkResponseCode(t, http.StatusOK, rr.Code)
  412. }
  413. func TestUpdateUserInvalidParamsMock(t *testing.T) {
  414. user := getTestUser()
  415. userAsJSON := getUserAsJSON(t, user)
  416. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  417. rr := executeRequest(req)
  418. checkResponseCode(t, http.StatusOK, rr.Code)
  419. err := render.DecodeJSON(rr.Body, &user)
  420. if err != nil {
  421. t.Errorf("Error get user: %v", err)
  422. }
  423. user.HomeDir = ""
  424. userAsJSON = getUserAsJSON(t, user)
  425. req, _ = http.NewRequest(http.MethodPut, userPath+"/"+strconv.FormatInt(user.ID, 10), bytes.NewBuffer(userAsJSON))
  426. rr = executeRequest(req)
  427. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  428. userID := user.ID
  429. user.ID = 0
  430. userAsJSON = getUserAsJSON(t, user)
  431. req, _ = http.NewRequest(http.MethodPut, userPath+"/"+strconv.FormatInt(userID, 10), bytes.NewBuffer(userAsJSON))
  432. rr = executeRequest(req)
  433. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  434. user.ID = userID
  435. req, _ = http.NewRequest(http.MethodPut, userPath+"/0", bytes.NewBuffer(userAsJSON))
  436. rr = executeRequest(req)
  437. checkResponseCode(t, http.StatusNotFound, rr.Code)
  438. req, _ = http.NewRequest(http.MethodPut, userPath+"/a", bytes.NewBuffer(userAsJSON))
  439. rr = executeRequest(req)
  440. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  441. req, _ = http.NewRequest(http.MethodDelete, userPath+"/"+strconv.FormatInt(user.ID, 10), nil)
  442. rr = executeRequest(req)
  443. checkResponseCode(t, http.StatusOK, rr.Code)
  444. }
  445. func TestGetUsersMock(t *testing.T) {
  446. user := getTestUser()
  447. userAsJSON := getUserAsJSON(t, user)
  448. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  449. rr := executeRequest(req)
  450. checkResponseCode(t, http.StatusOK, rr.Code)
  451. err := render.DecodeJSON(rr.Body, &user)
  452. if err != nil {
  453. t.Errorf("Error get user: %v", err)
  454. }
  455. req, _ = http.NewRequest(http.MethodGet, userPath+"?limit=510&offset=0&order=ASC&username="+defaultUsername, nil)
  456. rr = executeRequest(req)
  457. checkResponseCode(t, http.StatusOK, rr.Code)
  458. var users []dataprovider.User
  459. err = render.DecodeJSON(rr.Body, &users)
  460. if err != nil {
  461. t.Errorf("Error decoding users: %v", err)
  462. }
  463. if len(users) != 1 {
  464. t.Errorf("1 user is expected")
  465. }
  466. req, _ = http.NewRequest(http.MethodGet, userPath+"?limit=a&offset=0&order=ASC", nil)
  467. rr = executeRequest(req)
  468. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  469. req, _ = http.NewRequest(http.MethodGet, userPath+"?limit=1&offset=a&order=ASC", nil)
  470. rr = executeRequest(req)
  471. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  472. req, _ = http.NewRequest(http.MethodGet, userPath+"?limit=1&offset=0&order=ASCa", nil)
  473. rr = executeRequest(req)
  474. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  475. req, _ = http.NewRequest(http.MethodDelete, userPath+"/"+strconv.FormatInt(user.ID, 10), nil)
  476. rr = executeRequest(req)
  477. checkResponseCode(t, http.StatusOK, rr.Code)
  478. }
  479. func TestDeleteUserInvalidParamsMock(t *testing.T) {
  480. req, _ := http.NewRequest(http.MethodDelete, userPath+"/0", nil)
  481. rr := executeRequest(req)
  482. checkResponseCode(t, http.StatusNotFound, rr.Code)
  483. req, _ = http.NewRequest(http.MethodDelete, userPath+"/a", nil)
  484. rr = executeRequest(req)
  485. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  486. }
  487. func TestGetQuotaScansMock(t *testing.T) {
  488. req, err := http.NewRequest("GET", quotaScanPath, nil)
  489. if err != nil {
  490. t.Errorf("error get quota scan: %v", err)
  491. }
  492. rr := executeRequest(req)
  493. checkResponseCode(t, http.StatusOK, rr.Code)
  494. }
  495. func TestStartQuotaScanMock(t *testing.T) {
  496. user := getTestUser()
  497. userAsJSON := getUserAsJSON(t, user)
  498. req, _ := http.NewRequest(http.MethodPost, userPath, bytes.NewBuffer(userAsJSON))
  499. rr := executeRequest(req)
  500. checkResponseCode(t, http.StatusOK, rr.Code)
  501. err := render.DecodeJSON(rr.Body, &user)
  502. if err != nil {
  503. t.Errorf("Error get user: %v", err)
  504. }
  505. _, err = os.Stat(user.HomeDir)
  506. if err == nil {
  507. os.Remove(user.HomeDir)
  508. }
  509. userAsJSON = getUserAsJSON(t, user)
  510. req, _ = http.NewRequest(http.MethodPost, quotaScanPath, bytes.NewBuffer(userAsJSON))
  511. rr = executeRequest(req)
  512. checkResponseCode(t, http.StatusCreated, rr.Code)
  513. req, _ = http.NewRequest(http.MethodGet, quotaScanPath, nil)
  514. rr = executeRequest(req)
  515. checkResponseCode(t, http.StatusOK, rr.Code)
  516. var scans []sftpd.ActiveQuotaScan
  517. err = render.DecodeJSON(rr.Body, &scans)
  518. if err != nil {
  519. t.Errorf("Error get active scans: %v", err)
  520. }
  521. for len(scans) > 0 {
  522. req, _ = http.NewRequest(http.MethodGet, quotaScanPath, nil)
  523. rr = executeRequest(req)
  524. checkResponseCode(t, http.StatusOK, rr.Code)
  525. err = render.DecodeJSON(rr.Body, &scans)
  526. if err != nil {
  527. t.Errorf("Error get active scans: %v", err)
  528. break
  529. }
  530. }
  531. _, err = os.Stat(user.HomeDir)
  532. if err != nil && os.IsNotExist(err) {
  533. os.MkdirAll(user.HomeDir, 0777)
  534. }
  535. req, _ = http.NewRequest(http.MethodPost, quotaScanPath, bytes.NewBuffer(userAsJSON))
  536. rr = executeRequest(req)
  537. checkResponseCode(t, http.StatusCreated, rr.Code)
  538. req, _ = http.NewRequest(http.MethodDelete, userPath+"/"+strconv.FormatInt(user.ID, 10), nil)
  539. rr = executeRequest(req)
  540. checkResponseCode(t, http.StatusOK, rr.Code)
  541. }
  542. func TestStartQuotaScanBadUserMock(t *testing.T) {
  543. user := getTestUser()
  544. userAsJSON := getUserAsJSON(t, user)
  545. req, _ := http.NewRequest(http.MethodPost, quotaScanPath, bytes.NewBuffer(userAsJSON))
  546. rr := executeRequest(req)
  547. checkResponseCode(t, http.StatusNotFound, rr.Code)
  548. }
  549. func TestStartQuotaScanNonExistentUserMock(t *testing.T) {
  550. req, _ := http.NewRequest(http.MethodPost, quotaScanPath, bytes.NewBuffer([]byte("invalid json")))
  551. rr := executeRequest(req)
  552. checkResponseCode(t, http.StatusBadRequest, rr.Code)
  553. }
  554. func TestGetSFTPConnectionsMock(t *testing.T) {
  555. req, _ := http.NewRequest(http.MethodGet, activeConnectionsPath, nil)
  556. rr := executeRequest(req)
  557. checkResponseCode(t, http.StatusOK, rr.Code)
  558. }
  559. func TestDeleteActiveConnectionMock(t *testing.T) {
  560. req, _ := http.NewRequest(http.MethodDelete, activeConnectionsPath+"/connectionID", nil)
  561. rr := executeRequest(req)
  562. checkResponseCode(t, http.StatusNotFound, rr.Code)
  563. }
  564. func TestNotFoundMock(t *testing.T) {
  565. req, _ := http.NewRequest(http.MethodGet, "/non/existing/path", nil)
  566. rr := executeRequest(req)
  567. checkResponseCode(t, http.StatusNotFound, rr.Code)
  568. }
  569. func TestMethodNotAllowedMock(t *testing.T) {
  570. req, _ := http.NewRequest(http.MethodPost, activeConnectionsPath, nil)
  571. rr := executeRequest(req)
  572. checkResponseCode(t, http.StatusMethodNotAllowed, rr.Code)
  573. }
  574. func waitTCPListening(address string) {
  575. for {
  576. conn, err := net.Dial("tcp", address)
  577. if err != nil {
  578. logger.WarnToConsole("tcp server %v not listening: %v\n", address, err)
  579. time.Sleep(100 * time.Millisecond)
  580. continue
  581. }
  582. logger.InfoToConsole("tcp server %v now listening\n", address)
  583. defer conn.Close()
  584. break
  585. }
  586. }
  587. func getTestUser() dataprovider.User {
  588. return dataprovider.User{
  589. Username: defaultUsername,
  590. Password: defaultPassword,
  591. HomeDir: filepath.Join(homeBasePath, defaultUsername),
  592. Permissions: defaultPerms,
  593. }
  594. }
  595. func getUserAsJSON(t *testing.T, user dataprovider.User) []byte {
  596. json, err := json.Marshal(user)
  597. if err != nil {
  598. t.Errorf("error get user as json: %v", err)
  599. return []byte("{}")
  600. }
  601. return json
  602. }
  603. func executeRequest(req *http.Request) *httptest.ResponseRecorder {
  604. rr := httptest.NewRecorder()
  605. testServer.Config.Handler.ServeHTTP(rr, req)
  606. return rr
  607. }
  608. func checkResponseCode(t *testing.T, expected, actual int) {
  609. if expected != actual {
  610. t.Errorf("Expected response code %d. Got %d", expected, actual)
  611. }
  612. }