File: SyncIgnoreTests.cpp

package info (click to toggle)
megacmd 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 32,592 kB
  • sloc: cpp: 326,437; ansic: 34,524; python: 4,630; java: 3,965; sh: 2,869; objc: 2,459; makefile: 197; xml: 113
file content (284 lines) | stat: -rw-r--r-- 10,314 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/**
 * (c) 2013 by Mega Limited, Auckland, New Zealand
 *
 * This file is part of MEGAcmd.
 *
 * MEGAcmd is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * @copyright Simplified (2-clause) BSD License.
 *
 * You should have received a copy of the license along with this
 * program.
 */

#include <filesystem>
#include <gtest/gtest.h>
#include <gmock/gmock.h>

#include "megacmdcommonutils.h"
#include "TestUtils.h"
#include "MegaCmdTestingTools.h"

using namespace megacmd;
using TI = TestInstruments;

class SyncIgnoreTests : public NOINTERACTIVELoggedInTest
{
    void SetUp() override
    {
        NOINTERACTIVELoggedInTest::SetUp();
        TearDown();
    }

    void TearDown() override
    {
        removeAllSyncs();
        writeToDefaultFile();
    }

protected:
    SelfDeletingTmpFolder mTmpDir;

    void writeToDefaultFile(const std::vector<std::string>& lines = {})
    {
        auto platformDirs = PlatformDirectories::getPlatformSpecificDirectories();
        auto configDirPath = platformDirs->configDirPath();
        const fs::path megaIgnorePath = configDirPath / ".megaignore.default";

        std::ofstream file(megaIgnorePath);
        ASSERT_TRUE(file.is_open());

        for (const std::string& line : lines)
        {
            file << line << '\n';
        }
        ASSERT_FALSE(file.fail());
    }

    void readFromDefaultFile(std::string& contents) // cannot return string or asserts won't work
    {
        auto platformDirs = PlatformDirectories::getPlatformSpecificDirectories();
        auto configDirPath = platformDirs->configDirPath();
        const fs::path megaIgnorePath = configDirPath / ".megaignore.default";

        std::ifstream file(megaIgnorePath);
        ASSERT_TRUE(file.is_open());

        for (std::string line; getline(file, line);)
        {
            contents += line + "\n";
        }
        ASSERT_TRUE(file.eof());
    }

    std::string qw(const std::string& str) // quote wrap
    {
        return "\"" + str + "\"";
    }
};

TEST_F(SyncIgnoreTests, DefaultIgnoreFile)
{
    auto result = executeInClient({"sync-ignore", "DEFAULT"});
    ASSERT_TRUE(result.ok());

    result = executeInClient({"sync-ignore", "default"});
    ASSERT_TRUE(result.ok());
}

TEST_F(SyncIgnoreTests, AddAndShow)
{
    std::string filter1 = "-:some_file.txt";
    std::string filter2 = "-fp:video/*.avi";
    std::string filter3 = "+fng:family*.jpg";
    std::string filter4 = "-d:private";
    std::string filter5 = "-:*";

    auto result = executeInClient({"sync-ignore", "--add", "--", filter1, filter2, filter3, filter4, filter5, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter1)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter2)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter3)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter4)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter5)));

    result = executeInClient({"sync-ignore", "--show", "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr(filter1));
    EXPECT_THAT(result.out(), testing::HasSubstr(filter2));
    EXPECT_THAT(result.out(), testing::HasSubstr(filter3));
    EXPECT_THAT(result.out(), testing::HasSubstr(filter4));
    EXPECT_THAT(result.out(), testing::HasSubstr(filter5));
}

TEST_F(SyncIgnoreTests, AddAndRemove)
{
    std::string filter = "-N:*.avi";

    auto result = executeInClient({"sync-ignore", "--add", "--", filter, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter)));

    result = executeInClient({"sync-ignore", "--remove", "--", filter, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter " + qw(filter)));

    result = executeInClient({"sync-ignore", "--show", "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::Not(testing::HasSubstr(filter)));
}

TEST_F(SyncIgnoreTests, AddAndRemoveWithExclusionArgument)
{
    std::string filter1 = "n:*.mp4";
    std::string filter2 = "fp:pics/*.jpg";
    std::string filter3 = "d:private";

    auto result = executeInClient({"sync-ignore", "--add-exclusion", filter1, filter2, filter3, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw("-" + filter1)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw("-" + filter2)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw("-" + filter3)));

    result = executeInClient({"sync-ignore", "--remove-exclusion", filter1, filter2, filter3, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter " + qw("-" + filter1)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter " + qw("-" + filter2)));
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter " + qw("-" + filter3)));

    result = executeInClient({"sync-ignore", "--show", "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::Not(testing::HasSubstr(filter1)));
    EXPECT_THAT(result.out(), testing::Not(testing::HasSubstr(filter2)));
    EXPECT_THAT(result.out(), testing::Not(testing::HasSubstr(filter3)));
}

TEST_F(SyncIgnoreTests, CannotAddIfAlreadyExists)
{
    std::string filter = "+fg:work*.txt";

    auto result = executeInClient({"sync-ignore", "--add", "--", filter, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter)));

    result = executeInClient({"sync-ignore", "--add", "--", filter, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Cannot add filter " + qw(filter)));
    EXPECT_THAT(result.out(), testing::HasSubstr("already in the .megaignore file"));
}

TEST_F(SyncIgnoreTests, CannotRemoveIfDoesntExist)
{
    std::string filter = "+fnpg:family*.jpg";

    auto result = executeInClient({"sync-ignore", "--remove", "--", filter, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Cannot remove filter " + qw(filter)));
    EXPECT_THAT(result.out(), testing::HasSubstr("it's not in the .megaignore file"));
}

TEST_F(SyncIgnoreTests, NonDefaultIgnoreFile)
{
    std::string localDir = mTmpDir.string();

#ifdef __APPLE__
    localDir = "/private" + localDir;
#endif

    std::string cloudDir = "cloud_dir";
    TI::ScopeGuard cloudRmGuard([&cloudDir] { executeInClient({"rm", "-r", "-f", cloudDir}); });
    executeInClient({"rm", "-r", "-f", cloudDir});

    auto result = executeInClient({"mkdir", "-p", cloudDir});
    ASSERT_TRUE(result.ok());

    result = executeInClient({"sync", localDir, cloudDir});
    ASSERT_TRUE(result.ok());

    result = executeInClient({"sync-ignore", "--show", localDir});
    ASSERT_TRUE(result.ok());

    std::string filter = "-d:.vscode";

    result = executeInClient({"sync-ignore", "--add", "--", filter, localDir});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter " + qw(filter)));

    result = executeInClient({"sync-ignore", "--show", localDir});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr(filter));

    result = executeInClient({"sync-ignore", "--remove", "--", filter, localDir});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter " + qw(filter)));
}

TEST_F(SyncIgnoreTests, NonExistingIgnoreFile)
{
    std::string invalidSyncDir = "some_sync_dir";

    auto result = executeInClient({"sync-ignore", "--show", invalidSyncDir});
    ASSERT_FALSE(result.ok());
    EXPECT_THAT(result.err(), testing::HasSubstr("Sync " + invalidSyncDir + " was not found"));

    // Must also work with implicit "--show"
    result = executeInClient({"sync-ignore", invalidSyncDir});
    ASSERT_FALSE(result.ok());
    EXPECT_THAT(result.err(), testing::HasSubstr("Sync " + invalidSyncDir + " was not found"));
}

TEST_F(SyncIgnoreTests, IncorrectFilterFormat)
{
    std::string validFilter = "-fp:video/*.avi";
    std::string invalidFilter = "video/family/*.avi";

    auto result = executeInClient({"sync-ignore", "--add", "--", validFilter, invalidFilter, "DEFAULT"});
    ASSERT_FALSE(result.ok());
    EXPECT_THAT(result.err(), testing::HasSubstr("The filter " + qw(invalidFilter) + " does not have valid format"));
}

TEST_F(SyncIgnoreTests, CommentsAndBOMNotRemoved)
{
    std::string BOM = "\xEF\xBB\xBF";
    std::string comment = "# This is a comment";
    std::string filter = "-nr:.*foo";
    writeToDefaultFile({BOM, comment, filter});

    auto result = executeInClient({"sync-ignore", "--remove", "--", filter, "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter " + qw(filter)));

    std::string contents;
    readFromDefaultFile(contents);
    EXPECT_THAT(contents, testing::HasSubstr(BOM));
    EXPECT_THAT(contents, testing::HasSubstr(comment));
}

TEST_F(SyncIgnoreTests, UseExcludeInterface)
{
    std::string pattern = "*.pdf";

    auto result = executeInClient({"sync-ignore", "--show", "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::Not(testing::HasSubstr(pattern)));

    result = executeInClient({"exclude", "-a", pattern});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Added filter"));
    EXPECT_THAT(result.out(), testing::HasSubstr(pattern));

    result = executeInClient({"sync-ignore", "--show", "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr(pattern));

    result = executeInClient({"exclude", "-d", pattern});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::HasSubstr("Removed filter"));
    EXPECT_THAT(result.out(), testing::HasSubstr(pattern));

    result = executeInClient({"sync-ignore", "--show", "DEFAULT"});
    ASSERT_TRUE(result.ok());
    EXPECT_THAT(result.out(), testing::Not(testing::HasSubstr(pattern)));
}