eventmanager_test.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959
  1. // Copyright (C) 2019-2022 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. package common
  15. import (
  16. "fmt"
  17. "net/http"
  18. "os"
  19. "path"
  20. "path/filepath"
  21. "runtime"
  22. "strings"
  23. "testing"
  24. "time"
  25. "github.com/sftpgo/sdk"
  26. sdkkms "github.com/sftpgo/sdk/kms"
  27. "github.com/stretchr/testify/assert"
  28. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  29. "github.com/drakkan/sftpgo/v2/internal/kms"
  30. "github.com/drakkan/sftpgo/v2/internal/util"
  31. "github.com/drakkan/sftpgo/v2/internal/vfs"
  32. )
  33. func TestEventRuleMatch(t *testing.T) {
  34. conditions := dataprovider.EventConditions{
  35. ProviderEvents: []string{"add", "update"},
  36. Options: dataprovider.ConditionOptions{
  37. Names: []dataprovider.ConditionPattern{
  38. {
  39. Pattern: "user1",
  40. InverseMatch: true,
  41. },
  42. },
  43. },
  44. }
  45. res := eventManager.checkProviderEventMatch(conditions, EventParams{
  46. Name: "user1",
  47. Event: "add",
  48. })
  49. assert.False(t, res)
  50. res = eventManager.checkProviderEventMatch(conditions, EventParams{
  51. Name: "user2",
  52. Event: "update",
  53. })
  54. assert.True(t, res)
  55. res = eventManager.checkProviderEventMatch(conditions, EventParams{
  56. Name: "user2",
  57. Event: "delete",
  58. })
  59. assert.False(t, res)
  60. conditions.Options.ProviderObjects = []string{"api_key"}
  61. res = eventManager.checkProviderEventMatch(conditions, EventParams{
  62. Name: "user2",
  63. Event: "update",
  64. ObjectType: "share",
  65. })
  66. assert.False(t, res)
  67. res = eventManager.checkProviderEventMatch(conditions, EventParams{
  68. Name: "user2",
  69. Event: "update",
  70. ObjectType: "api_key",
  71. })
  72. assert.True(t, res)
  73. // now test fs events
  74. conditions = dataprovider.EventConditions{
  75. FsEvents: []string{operationUpload, operationDownload},
  76. Options: dataprovider.ConditionOptions{
  77. Names: []dataprovider.ConditionPattern{
  78. {
  79. Pattern: "user*",
  80. },
  81. {
  82. Pattern: "tester*",
  83. },
  84. },
  85. FsPaths: []dataprovider.ConditionPattern{
  86. {
  87. Pattern: "*.txt",
  88. },
  89. },
  90. Protocols: []string{ProtocolSFTP},
  91. MinFileSize: 10,
  92. MaxFileSize: 30,
  93. },
  94. }
  95. params := EventParams{
  96. Name: "tester4",
  97. Event: operationDelete,
  98. VirtualPath: "/path.txt",
  99. Protocol: ProtocolSFTP,
  100. ObjectName: "path.txt",
  101. FileSize: 20,
  102. }
  103. res = eventManager.checkFsEventMatch(conditions, params)
  104. assert.False(t, res)
  105. params.Event = operationDownload
  106. res = eventManager.checkFsEventMatch(conditions, params)
  107. assert.True(t, res)
  108. params.Name = "name"
  109. res = eventManager.checkFsEventMatch(conditions, params)
  110. assert.False(t, res)
  111. params.Name = "user5"
  112. res = eventManager.checkFsEventMatch(conditions, params)
  113. assert.True(t, res)
  114. params.VirtualPath = "/sub/f.jpg"
  115. params.ObjectName = path.Base(params.VirtualPath)
  116. res = eventManager.checkFsEventMatch(conditions, params)
  117. assert.False(t, res)
  118. params.VirtualPath = "/sub/f.txt"
  119. params.ObjectName = path.Base(params.VirtualPath)
  120. res = eventManager.checkFsEventMatch(conditions, params)
  121. assert.True(t, res)
  122. params.Protocol = ProtocolHTTP
  123. res = eventManager.checkFsEventMatch(conditions, params)
  124. assert.False(t, res)
  125. params.Protocol = ProtocolSFTP
  126. params.FileSize = 5
  127. res = eventManager.checkFsEventMatch(conditions, params)
  128. assert.False(t, res)
  129. params.FileSize = 50
  130. res = eventManager.checkFsEventMatch(conditions, params)
  131. assert.False(t, res)
  132. params.FileSize = 25
  133. res = eventManager.checkFsEventMatch(conditions, params)
  134. assert.True(t, res)
  135. // bad pattern
  136. conditions.Options.Names = []dataprovider.ConditionPattern{
  137. {
  138. Pattern: "[-]",
  139. },
  140. }
  141. res = eventManager.checkFsEventMatch(conditions, params)
  142. assert.False(t, res)
  143. }
  144. func TestEventManager(t *testing.T) {
  145. startEventScheduler()
  146. action := &dataprovider.BaseEventAction{
  147. Name: "test_action",
  148. Type: dataprovider.ActionTypeHTTP,
  149. Options: dataprovider.BaseEventActionOptions{
  150. HTTPConfig: dataprovider.EventActionHTTPConfig{
  151. Endpoint: "http://localhost",
  152. Timeout: 20,
  153. Method: http.MethodGet,
  154. },
  155. },
  156. }
  157. err := dataprovider.AddEventAction(action, "", "")
  158. assert.NoError(t, err)
  159. rule := &dataprovider.EventRule{
  160. Name: "rule",
  161. Trigger: dataprovider.EventTriggerFsEvent,
  162. Conditions: dataprovider.EventConditions{
  163. FsEvents: []string{operationUpload},
  164. },
  165. Actions: []dataprovider.EventAction{
  166. {
  167. BaseEventAction: dataprovider.BaseEventAction{
  168. Name: action.Name,
  169. },
  170. Order: 1,
  171. },
  172. },
  173. }
  174. err = dataprovider.AddEventRule(rule, "", "")
  175. assert.NoError(t, err)
  176. eventManager.RLock()
  177. assert.Len(t, eventManager.FsEvents, 1)
  178. assert.Len(t, eventManager.ProviderEvents, 0)
  179. assert.Len(t, eventManager.Schedules, 0)
  180. assert.Len(t, eventManager.schedulesMapping, 0)
  181. eventManager.RUnlock()
  182. rule.Trigger = dataprovider.EventTriggerProviderEvent
  183. rule.Conditions = dataprovider.EventConditions{
  184. ProviderEvents: []string{"add"},
  185. }
  186. err = dataprovider.UpdateEventRule(rule, "", "")
  187. assert.NoError(t, err)
  188. eventManager.RLock()
  189. assert.Len(t, eventManager.FsEvents, 0)
  190. assert.Len(t, eventManager.ProviderEvents, 1)
  191. assert.Len(t, eventManager.Schedules, 0)
  192. assert.Len(t, eventManager.schedulesMapping, 0)
  193. eventManager.RUnlock()
  194. rule.Trigger = dataprovider.EventTriggerSchedule
  195. rule.Conditions = dataprovider.EventConditions{
  196. Schedules: []dataprovider.Schedule{
  197. {
  198. Hours: "0",
  199. DayOfWeek: "*",
  200. DayOfMonth: "*",
  201. Month: "*",
  202. },
  203. },
  204. }
  205. rule.DeletedAt = util.GetTimeAsMsSinceEpoch(time.Now().Add(-12 * time.Hour))
  206. eventManager.addUpdateRuleInternal(*rule)
  207. eventManager.RLock()
  208. assert.Len(t, eventManager.FsEvents, 0)
  209. assert.Len(t, eventManager.ProviderEvents, 0)
  210. assert.Len(t, eventManager.Schedules, 0)
  211. assert.Len(t, eventManager.schedulesMapping, 0)
  212. eventManager.RUnlock()
  213. assert.Eventually(t, func() bool {
  214. _, err = dataprovider.EventRuleExists(rule.Name)
  215. _, ok := err.(*util.RecordNotFoundError)
  216. return ok
  217. }, 2*time.Second, 100*time.Millisecond)
  218. rule.DeletedAt = 0
  219. err = dataprovider.AddEventRule(rule, "", "")
  220. assert.NoError(t, err)
  221. eventManager.RLock()
  222. assert.Len(t, eventManager.FsEvents, 0)
  223. assert.Len(t, eventManager.ProviderEvents, 0)
  224. assert.Len(t, eventManager.Schedules, 1)
  225. assert.Len(t, eventManager.schedulesMapping, 1)
  226. eventManager.RUnlock()
  227. err = dataprovider.DeleteEventRule(rule.Name, "", "")
  228. assert.NoError(t, err)
  229. eventManager.RLock()
  230. assert.Len(t, eventManager.FsEvents, 0)
  231. assert.Len(t, eventManager.ProviderEvents, 0)
  232. assert.Len(t, eventManager.Schedules, 0)
  233. assert.Len(t, eventManager.schedulesMapping, 0)
  234. eventManager.RUnlock()
  235. err = dataprovider.DeleteEventAction(action.Name, "", "")
  236. assert.NoError(t, err)
  237. stopEventScheduler()
  238. }
  239. func TestEventManagerErrors(t *testing.T) {
  240. startEventScheduler()
  241. providerConf := dataprovider.GetProviderConfig()
  242. err := dataprovider.Close()
  243. assert.NoError(t, err)
  244. params := EventParams{
  245. sender: "sender",
  246. }
  247. _, err = params.getUsers()
  248. assert.Error(t, err)
  249. _, err = params.getFolders()
  250. assert.Error(t, err)
  251. err = executeUsersQuotaResetRuleAction(dataprovider.ConditionOptions{}, EventParams{})
  252. assert.Error(t, err)
  253. err = executeFoldersQuotaResetRuleAction(dataprovider.ConditionOptions{}, EventParams{})
  254. assert.Error(t, err)
  255. err = executeTransferQuotaResetRuleAction(dataprovider.ConditionOptions{}, EventParams{})
  256. assert.Error(t, err)
  257. err = executeQuotaResetForUser(dataprovider.User{
  258. Groups: []sdk.GroupMapping{
  259. {
  260. Name: "agroup",
  261. Type: sdk.GroupTypePrimary,
  262. },
  263. },
  264. })
  265. assert.Error(t, err)
  266. err = executeDataRetentionCheckForUser(dataprovider.User{
  267. Groups: []sdk.GroupMapping{
  268. {
  269. Name: "agroup",
  270. Type: sdk.GroupTypePrimary,
  271. },
  272. },
  273. }, nil)
  274. assert.Error(t, err)
  275. dataRetentionAction := dataprovider.BaseEventAction{
  276. Type: dataprovider.ActionTypeDataRetentionCheck,
  277. Options: dataprovider.BaseEventActionOptions{
  278. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  279. Folders: []dataprovider.FolderRetention{
  280. {
  281. Path: "/",
  282. Retention: 24,
  283. },
  284. },
  285. },
  286. },
  287. }
  288. err = executeRuleAction(dataRetentionAction, EventParams{}, dataprovider.ConditionOptions{
  289. Names: []dataprovider.ConditionPattern{
  290. {
  291. Pattern: "username1",
  292. },
  293. },
  294. })
  295. if assert.Error(t, err) {
  296. assert.Contains(t, err.Error(), "unable to get users")
  297. }
  298. eventManager.loadRules()
  299. eventManager.RLock()
  300. assert.Len(t, eventManager.FsEvents, 0)
  301. assert.Len(t, eventManager.ProviderEvents, 0)
  302. assert.Len(t, eventManager.Schedules, 0)
  303. eventManager.RUnlock()
  304. // rule with invalid trigger
  305. eventManager.addUpdateRuleInternal(dataprovider.EventRule{
  306. Name: "test rule",
  307. Trigger: -1,
  308. })
  309. eventManager.RLock()
  310. assert.Len(t, eventManager.FsEvents, 0)
  311. assert.Len(t, eventManager.ProviderEvents, 0)
  312. assert.Len(t, eventManager.Schedules, 0)
  313. eventManager.RUnlock()
  314. // rule with invalid cronspec
  315. eventManager.addUpdateRuleInternal(dataprovider.EventRule{
  316. Name: "test rule",
  317. Trigger: dataprovider.EventTriggerSchedule,
  318. Conditions: dataprovider.EventConditions{
  319. Schedules: []dataprovider.Schedule{
  320. {
  321. Hours: "1000",
  322. },
  323. },
  324. },
  325. })
  326. eventManager.RLock()
  327. assert.Len(t, eventManager.FsEvents, 0)
  328. assert.Len(t, eventManager.ProviderEvents, 0)
  329. assert.Len(t, eventManager.Schedules, 0)
  330. eventManager.RUnlock()
  331. err = dataprovider.Initialize(providerConf, configDir, true)
  332. assert.NoError(t, err)
  333. stopEventScheduler()
  334. }
  335. func TestEventRuleActions(t *testing.T) {
  336. actionName := "test rule action"
  337. action := dataprovider.BaseEventAction{
  338. Name: actionName,
  339. Type: dataprovider.ActionTypeBackup,
  340. }
  341. err := executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{})
  342. assert.NoError(t, err)
  343. action.Type = -1
  344. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{})
  345. assert.Error(t, err)
  346. action = dataprovider.BaseEventAction{
  347. Name: actionName,
  348. Type: dataprovider.ActionTypeHTTP,
  349. Options: dataprovider.BaseEventActionOptions{
  350. HTTPConfig: dataprovider.EventActionHTTPConfig{
  351. Endpoint: "http://foo\x7f.com/", // invalid URL
  352. SkipTLSVerify: true,
  353. Body: "{{ObjectData}}",
  354. Method: http.MethodPost,
  355. QueryParameters: []dataprovider.KeyValue{
  356. {
  357. Key: "param",
  358. Value: "value",
  359. },
  360. },
  361. Timeout: 5,
  362. Headers: []dataprovider.KeyValue{
  363. {
  364. Key: "Content-Type",
  365. Value: "application/json",
  366. },
  367. },
  368. Username: "httpuser",
  369. },
  370. },
  371. }
  372. action.Options.SetEmptySecretsIfNil()
  373. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{})
  374. if assert.Error(t, err) {
  375. assert.Contains(t, err.Error(), "invalid endpoint")
  376. }
  377. action.Options.HTTPConfig.Endpoint = fmt.Sprintf("http://%v", httpAddr)
  378. params := EventParams{
  379. Name: "a",
  380. Object: &dataprovider.User{
  381. BaseUser: sdk.BaseUser{
  382. Username: "test user",
  383. },
  384. },
  385. }
  386. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  387. assert.NoError(t, err)
  388. action.Options.HTTPConfig.Endpoint = fmt.Sprintf("http://%v/404", httpAddr)
  389. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  390. if assert.Error(t, err) {
  391. assert.Equal(t, err.Error(), "unexpected status code: 404")
  392. }
  393. action.Options.HTTPConfig.Endpoint = "http://invalid:1234"
  394. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  395. assert.Error(t, err)
  396. action.Options.HTTPConfig.QueryParameters = nil
  397. action.Options.HTTPConfig.Endpoint = "http://bar\x7f.com/"
  398. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  399. assert.Error(t, err)
  400. action.Options.HTTPConfig.Password = kms.NewSecret(sdkkms.SecretStatusSecretBox, "payload", "key", "data")
  401. err = executeRuleAction(action, params, dataprovider.ConditionOptions{})
  402. if assert.Error(t, err) {
  403. assert.Contains(t, err.Error(), "unable to decrypt password")
  404. }
  405. // test disk and transfer quota reset
  406. username1 := "user1"
  407. username2 := "user2"
  408. user1 := dataprovider.User{
  409. BaseUser: sdk.BaseUser{
  410. Username: username1,
  411. HomeDir: filepath.Join(os.TempDir(), username1),
  412. Status: 1,
  413. Permissions: map[string][]string{
  414. "/": {dataprovider.PermAny},
  415. },
  416. },
  417. }
  418. user2 := dataprovider.User{
  419. BaseUser: sdk.BaseUser{
  420. Username: username2,
  421. HomeDir: filepath.Join(os.TempDir(), username2),
  422. Status: 1,
  423. Permissions: map[string][]string{
  424. "/": {dataprovider.PermAny},
  425. },
  426. },
  427. }
  428. err = dataprovider.AddUser(&user1, "", "")
  429. assert.NoError(t, err)
  430. err = dataprovider.AddUser(&user2, "", "")
  431. assert.NoError(t, err)
  432. action = dataprovider.BaseEventAction{
  433. Type: dataprovider.ActionTypeUserQuotaReset,
  434. }
  435. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  436. Names: []dataprovider.ConditionPattern{
  437. {
  438. Pattern: username1,
  439. },
  440. },
  441. })
  442. assert.Error(t, err) // no home dir
  443. // create the home dir
  444. err = os.MkdirAll(user1.GetHomeDir(), os.ModePerm)
  445. assert.NoError(t, err)
  446. err = os.WriteFile(filepath.Join(user1.GetHomeDir(), "file.txt"), []byte("user"), 0666)
  447. assert.NoError(t, err)
  448. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  449. Names: []dataprovider.ConditionPattern{
  450. {
  451. Pattern: username1,
  452. },
  453. },
  454. })
  455. assert.NoError(t, err)
  456. userGet, err := dataprovider.UserExists(username1)
  457. assert.NoError(t, err)
  458. assert.Equal(t, 1, userGet.UsedQuotaFiles)
  459. assert.Equal(t, int64(4), userGet.UsedQuotaSize)
  460. // simulate another quota scan in progress
  461. assert.True(t, QuotaScans.AddUserQuotaScan(username1))
  462. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  463. Names: []dataprovider.ConditionPattern{
  464. {
  465. Pattern: username1,
  466. },
  467. },
  468. })
  469. assert.Error(t, err)
  470. assert.True(t, QuotaScans.RemoveUserQuotaScan(username1))
  471. // non matching pattern
  472. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  473. Names: []dataprovider.ConditionPattern{
  474. {
  475. Pattern: "don't match",
  476. },
  477. },
  478. })
  479. if assert.Error(t, err) {
  480. assert.Contains(t, err.Error(), "no user quota reset executed")
  481. }
  482. dataRetentionAction := dataprovider.BaseEventAction{
  483. Type: dataprovider.ActionTypeDataRetentionCheck,
  484. Options: dataprovider.BaseEventActionOptions{
  485. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  486. Folders: []dataprovider.FolderRetention{
  487. {
  488. Path: "",
  489. Retention: 24,
  490. },
  491. },
  492. },
  493. },
  494. }
  495. err = executeRuleAction(dataRetentionAction, EventParams{}, dataprovider.ConditionOptions{
  496. Names: []dataprovider.ConditionPattern{
  497. {
  498. Pattern: username1,
  499. },
  500. },
  501. })
  502. assert.Error(t, err) // invalid config, no folder path specified
  503. retentionDir := "testretention"
  504. dataRetentionAction = dataprovider.BaseEventAction{
  505. Type: dataprovider.ActionTypeDataRetentionCheck,
  506. Options: dataprovider.BaseEventActionOptions{
  507. RetentionConfig: dataprovider.EventActionDataRetentionConfig{
  508. Folders: []dataprovider.FolderRetention{
  509. {
  510. Path: path.Join("/", retentionDir),
  511. Retention: 24,
  512. DeleteEmptyDirs: true,
  513. },
  514. },
  515. },
  516. },
  517. }
  518. // create some test files
  519. file1 := filepath.Join(user1.GetHomeDir(), "file1.txt")
  520. file2 := filepath.Join(user1.GetHomeDir(), retentionDir, "file2.txt")
  521. file3 := filepath.Join(user1.GetHomeDir(), retentionDir, "file3.txt")
  522. file4 := filepath.Join(user1.GetHomeDir(), retentionDir, "sub", "file4.txt")
  523. err = os.MkdirAll(filepath.Dir(file4), os.ModePerm)
  524. assert.NoError(t, err)
  525. for _, f := range []string{file1, file2, file3, file4} {
  526. err = os.WriteFile(f, []byte(""), 0666)
  527. assert.NoError(t, err)
  528. }
  529. timeBeforeRetention := time.Now().Add(-48 * time.Hour)
  530. err = os.Chtimes(file1, timeBeforeRetention, timeBeforeRetention)
  531. assert.NoError(t, err)
  532. err = os.Chtimes(file2, timeBeforeRetention, timeBeforeRetention)
  533. assert.NoError(t, err)
  534. err = os.Chtimes(file4, timeBeforeRetention, timeBeforeRetention)
  535. assert.NoError(t, err)
  536. err = executeRuleAction(dataRetentionAction, EventParams{}, dataprovider.ConditionOptions{
  537. Names: []dataprovider.ConditionPattern{
  538. {
  539. Pattern: username1,
  540. },
  541. },
  542. })
  543. assert.NoError(t, err)
  544. assert.FileExists(t, file1)
  545. assert.NoFileExists(t, file2)
  546. assert.FileExists(t, file3)
  547. assert.NoDirExists(t, filepath.Dir(file4))
  548. // simulate another check in progress
  549. c := RetentionChecks.Add(RetentionCheck{}, &user1)
  550. assert.NotNil(t, c)
  551. err = executeRuleAction(dataRetentionAction, EventParams{}, dataprovider.ConditionOptions{
  552. Names: []dataprovider.ConditionPattern{
  553. {
  554. Pattern: username1,
  555. },
  556. },
  557. })
  558. assert.Error(t, err)
  559. RetentionChecks.remove(user1.Username)
  560. err = executeRuleAction(dataRetentionAction, EventParams{}, dataprovider.ConditionOptions{
  561. Names: []dataprovider.ConditionPattern{
  562. {
  563. Pattern: "no match",
  564. },
  565. },
  566. })
  567. if assert.Error(t, err) {
  568. assert.Contains(t, err.Error(), "no retention check executed")
  569. }
  570. err = os.RemoveAll(user1.GetHomeDir())
  571. assert.NoError(t, err)
  572. err = dataprovider.UpdateUserTransferQuota(&user1, 100, 100, true)
  573. assert.NoError(t, err)
  574. action.Type = dataprovider.ActionTypeTransferQuotaReset
  575. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  576. Names: []dataprovider.ConditionPattern{
  577. {
  578. Pattern: username1,
  579. },
  580. },
  581. })
  582. assert.NoError(t, err)
  583. userGet, err = dataprovider.UserExists(username1)
  584. assert.NoError(t, err)
  585. assert.Equal(t, int64(0), userGet.UsedDownloadDataTransfer)
  586. assert.Equal(t, int64(0), userGet.UsedUploadDataTransfer)
  587. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  588. Names: []dataprovider.ConditionPattern{
  589. {
  590. Pattern: "no match",
  591. },
  592. },
  593. })
  594. if assert.Error(t, err) {
  595. assert.Contains(t, err.Error(), "no transfer quota reset executed")
  596. }
  597. err = dataprovider.DeleteUser(username1, "", "")
  598. assert.NoError(t, err)
  599. err = dataprovider.DeleteUser(username2, "", "")
  600. assert.NoError(t, err)
  601. // test folder quota reset
  602. foldername1 := "f1"
  603. foldername2 := "f2"
  604. folder1 := vfs.BaseVirtualFolder{
  605. Name: foldername1,
  606. MappedPath: filepath.Join(os.TempDir(), foldername1),
  607. }
  608. folder2 := vfs.BaseVirtualFolder{
  609. Name: foldername2,
  610. MappedPath: filepath.Join(os.TempDir(), foldername2),
  611. }
  612. err = dataprovider.AddFolder(&folder1, "", "")
  613. assert.NoError(t, err)
  614. err = dataprovider.AddFolder(&folder2, "", "")
  615. assert.NoError(t, err)
  616. action = dataprovider.BaseEventAction{
  617. Type: dataprovider.ActionTypeFolderQuotaReset,
  618. }
  619. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  620. Names: []dataprovider.ConditionPattern{
  621. {
  622. Pattern: foldername1,
  623. },
  624. },
  625. })
  626. assert.Error(t, err) // no home dir
  627. err = os.MkdirAll(folder1.MappedPath, os.ModePerm)
  628. assert.NoError(t, err)
  629. err = os.WriteFile(filepath.Join(folder1.MappedPath, "file.txt"), []byte("folder"), 0666)
  630. assert.NoError(t, err)
  631. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  632. Names: []dataprovider.ConditionPattern{
  633. {
  634. Pattern: foldername1,
  635. },
  636. },
  637. })
  638. assert.NoError(t, err)
  639. folderGet, err := dataprovider.GetFolderByName(foldername1)
  640. assert.NoError(t, err)
  641. assert.Equal(t, 1, folderGet.UsedQuotaFiles)
  642. assert.Equal(t, int64(6), folderGet.UsedQuotaSize)
  643. // simulate another quota scan in progress
  644. assert.True(t, QuotaScans.AddVFolderQuotaScan(foldername1))
  645. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  646. Names: []dataprovider.ConditionPattern{
  647. {
  648. Pattern: foldername1,
  649. },
  650. },
  651. })
  652. assert.Error(t, err)
  653. assert.True(t, QuotaScans.RemoveVFolderQuotaScan(foldername1))
  654. err = executeRuleAction(action, EventParams{}, dataprovider.ConditionOptions{
  655. Names: []dataprovider.ConditionPattern{
  656. {
  657. Pattern: "no folder match",
  658. },
  659. },
  660. })
  661. if assert.Error(t, err) {
  662. assert.Contains(t, err.Error(), "no folder quota reset executed")
  663. }
  664. err = os.RemoveAll(folder1.MappedPath)
  665. assert.NoError(t, err)
  666. err = dataprovider.DeleteFolder(foldername1, "", "")
  667. assert.NoError(t, err)
  668. err = dataprovider.DeleteFolder(foldername2, "", "")
  669. assert.NoError(t, err)
  670. }
  671. func TestFilesystemActionErrors(t *testing.T) {
  672. err := executeFsRuleAction(dataprovider.EventActionFilesystemConfig{}, EventParams{})
  673. if assert.Error(t, err) {
  674. assert.Contains(t, err.Error(), "unsupported filesystem action")
  675. }
  676. username := "test_user_for_actions"
  677. testReplacer := strings.NewReplacer("old", "new")
  678. err = executeDeleteFsAction(nil, testReplacer, username)
  679. assert.Error(t, err)
  680. err = executeMkDirsFsAction(nil, testReplacer, username)
  681. assert.Error(t, err)
  682. err = executeRenameFsAction(nil, testReplacer, username)
  683. assert.Error(t, err)
  684. user := dataprovider.User{
  685. BaseUser: sdk.BaseUser{
  686. Username: username,
  687. Permissions: map[string][]string{
  688. "/": {dataprovider.PermAny},
  689. },
  690. HomeDir: filepath.Join(os.TempDir(), username),
  691. },
  692. FsConfig: vfs.Filesystem{
  693. Provider: sdk.SFTPFilesystemProvider,
  694. SFTPConfig: vfs.SFTPFsConfig{
  695. BaseSFTPFsConfig: sdk.BaseSFTPFsConfig{
  696. Endpoint: "127.0.0.1:4022",
  697. Username: username,
  698. },
  699. Password: kms.NewPlainSecret("pwd"),
  700. },
  701. },
  702. }
  703. conn := NewBaseConnection("", protocolEventAction, "", "", user)
  704. err = executeDeleteFileFsAction(conn, "", nil)
  705. assert.Error(t, err)
  706. err = dataprovider.AddUser(&user, "", "")
  707. assert.NoError(t, err)
  708. // check root fs fails
  709. err = executeDeleteFsAction(nil, testReplacer, username)
  710. assert.Error(t, err)
  711. err = executeMkDirsFsAction(nil, testReplacer, username)
  712. assert.Error(t, err)
  713. err = executeRenameFsAction(nil, testReplacer, username)
  714. assert.Error(t, err)
  715. user.FsConfig.Provider = sdk.LocalFilesystemProvider
  716. user.Permissions["/"] = []string{dataprovider.PermUpload}
  717. err = dataprovider.DeleteUser(username, "", "")
  718. assert.NoError(t, err)
  719. err = dataprovider.AddUser(&user, "", "")
  720. assert.NoError(t, err)
  721. err = executeRenameFsAction([]dataprovider.KeyValue{
  722. {
  723. Key: "/p1",
  724. Value: "/p1",
  725. },
  726. }, testReplacer, username)
  727. if assert.Error(t, err) {
  728. assert.Contains(t, err.Error(), "the rename source and target cannot be the same")
  729. }
  730. if runtime.GOOS != osWindows {
  731. dirPath := filepath.Join(user.HomeDir, "adir", "sub")
  732. err := os.MkdirAll(dirPath, os.ModePerm)
  733. assert.NoError(t, err)
  734. filePath := filepath.Join(dirPath, "f.dat")
  735. err = os.WriteFile(filePath, nil, 0666)
  736. assert.NoError(t, err)
  737. err = os.Chmod(dirPath, 0001)
  738. assert.NoError(t, err)
  739. err = executeDeleteFsAction([]string{"/adir/sub"}, testReplacer, username)
  740. assert.Error(t, err)
  741. err = executeDeleteFsAction([]string{"/adir/sub/f.dat"}, testReplacer, username)
  742. assert.Error(t, err)
  743. err = os.Chmod(dirPath, 0555)
  744. assert.NoError(t, err)
  745. err = executeDeleteFsAction([]string{"/adir/sub/f.dat"}, testReplacer, username)
  746. assert.Error(t, err)
  747. err = executeMkDirsFsAction([]string{"/adir/sub"}, testReplacer, username)
  748. assert.Error(t, err)
  749. err = executeMkDirsFsAction([]string{"/adir/sub/sub/sub"}, testReplacer, username)
  750. assert.Error(t, err)
  751. err = os.Chmod(dirPath, os.ModePerm)
  752. assert.NoError(t, err)
  753. }
  754. err = dataprovider.DeleteUser(username, "", "")
  755. assert.NoError(t, err)
  756. err = os.RemoveAll(user.GetHomeDir())
  757. assert.NoError(t, err)
  758. }
  759. func TestQuotaActionsWithQuotaTrackDisabled(t *testing.T) {
  760. oldProviderConf := dataprovider.GetProviderConfig()
  761. providerConf := dataprovider.GetProviderConfig()
  762. providerConf.TrackQuota = 0
  763. err := dataprovider.Close()
  764. assert.NoError(t, err)
  765. err = dataprovider.Initialize(providerConf, configDir, true)
  766. assert.NoError(t, err)
  767. username := "u1"
  768. user := dataprovider.User{
  769. BaseUser: sdk.BaseUser{
  770. Username: username,
  771. HomeDir: filepath.Join(os.TempDir(), username),
  772. Status: 1,
  773. Permissions: map[string][]string{
  774. "/": {dataprovider.PermAny},
  775. },
  776. },
  777. FsConfig: vfs.Filesystem{
  778. Provider: sdk.LocalFilesystemProvider,
  779. },
  780. }
  781. err = dataprovider.AddUser(&user, "", "")
  782. assert.NoError(t, err)
  783. err = os.MkdirAll(user.GetHomeDir(), os.ModePerm)
  784. assert.NoError(t, err)
  785. err = executeRuleAction(dataprovider.BaseEventAction{Type: dataprovider.ActionTypeUserQuotaReset},
  786. EventParams{}, dataprovider.ConditionOptions{
  787. Names: []dataprovider.ConditionPattern{
  788. {
  789. Pattern: username,
  790. },
  791. },
  792. })
  793. assert.Error(t, err)
  794. err = executeRuleAction(dataprovider.BaseEventAction{Type: dataprovider.ActionTypeTransferQuotaReset},
  795. EventParams{}, dataprovider.ConditionOptions{
  796. Names: []dataprovider.ConditionPattern{
  797. {
  798. Pattern: username,
  799. },
  800. },
  801. })
  802. assert.Error(t, err)
  803. err = os.RemoveAll(user.GetHomeDir())
  804. assert.NoError(t, err)
  805. err = dataprovider.DeleteUser(username, "", "")
  806. assert.NoError(t, err)
  807. foldername := "f1"
  808. folder := vfs.BaseVirtualFolder{
  809. Name: foldername,
  810. MappedPath: filepath.Join(os.TempDir(), foldername),
  811. }
  812. err = dataprovider.AddFolder(&folder, "", "")
  813. assert.NoError(t, err)
  814. err = os.MkdirAll(folder.MappedPath, os.ModePerm)
  815. assert.NoError(t, err)
  816. err = executeRuleAction(dataprovider.BaseEventAction{Type: dataprovider.ActionTypeFolderQuotaReset},
  817. EventParams{}, dataprovider.ConditionOptions{
  818. Names: []dataprovider.ConditionPattern{
  819. {
  820. Pattern: foldername,
  821. },
  822. },
  823. })
  824. assert.Error(t, err)
  825. err = os.RemoveAll(folder.MappedPath)
  826. assert.NoError(t, err)
  827. err = dataprovider.DeleteFolder(foldername, "", "")
  828. assert.NoError(t, err)
  829. err = dataprovider.Close()
  830. assert.NoError(t, err)
  831. err = dataprovider.Initialize(oldProviderConf, configDir, true)
  832. assert.NoError(t, err)
  833. }
  834. func TestScheduledActions(t *testing.T) {
  835. startEventScheduler()
  836. backupsPath := filepath.Join(os.TempDir(), "backups")
  837. err := os.RemoveAll(backupsPath)
  838. assert.NoError(t, err)
  839. action := &dataprovider.BaseEventAction{
  840. Name: "action",
  841. Type: dataprovider.ActionTypeBackup,
  842. }
  843. err = dataprovider.AddEventAction(action, "", "")
  844. assert.NoError(t, err)
  845. rule := &dataprovider.EventRule{
  846. Name: "rule",
  847. Trigger: dataprovider.EventTriggerSchedule,
  848. Conditions: dataprovider.EventConditions{
  849. Schedules: []dataprovider.Schedule{
  850. {
  851. Hours: "11",
  852. DayOfWeek: "*",
  853. DayOfMonth: "*",
  854. Month: "*",
  855. },
  856. },
  857. },
  858. Actions: []dataprovider.EventAction{
  859. {
  860. BaseEventAction: dataprovider.BaseEventAction{
  861. Name: action.Name,
  862. },
  863. Order: 1,
  864. },
  865. },
  866. }
  867. job := eventCronJob{
  868. ruleName: rule.Name,
  869. }
  870. job.Run() // rule not found
  871. assert.NoDirExists(t, backupsPath)
  872. err = dataprovider.AddEventRule(rule, "", "")
  873. assert.NoError(t, err)
  874. job.Run()
  875. assert.DirExists(t, backupsPath)
  876. action.Type = dataprovider.ActionTypeFilesystem
  877. action.Options = dataprovider.BaseEventActionOptions{
  878. FsConfig: dataprovider.EventActionFilesystemConfig{
  879. Type: dataprovider.FilesystemActionMkdirs,
  880. MkDirs: []string{"/dir"},
  881. },
  882. }
  883. err = dataprovider.UpdateEventAction(action, "", "")
  884. assert.NoError(t, err)
  885. job.Run() // action is not compatible with a scheduled rule
  886. err = dataprovider.DeleteEventRule(rule.Name, "", "")
  887. assert.NoError(t, err)
  888. err = dataprovider.DeleteEventAction(action.Name, "", "")
  889. assert.NoError(t, err)
  890. err = os.RemoveAll(backupsPath)
  891. assert.NoError(t, err)
  892. stopEventScheduler()
  893. }