sparse: vendor Facebook-developed extension Facebook has developed an extension to enable "sparse" checkouts - a working directory with a subset of files. This feature is a critical component in enabling repositories to scale to infinite number of files while retaining reasonable performance. It's worth noting that sparse checkout is only one possible solution to this problem: another is virtual filesystems that realize files on first access. But given that virtual filesystems may not be accessible to all users, sparse checkout is necessary as a fallback. Per mailing list discussion at https://www.mercurial-scm.org/pipermail/mercurial-devel/2017-March/095868.html we want to add sparse checkout to the Mercurial distribution via roughly the following mechanism: 1. Vendor extension as-is with minimal modifications (this patch) 2. Refactor extension so it is more clearly experimental and inline with Mercurial practices 3. Move code from extension into core where possible 4. Drop experimental labeling and/or move feature into core after sign-off from narrow clone feature owners This commit essentially copies the sparse extension and tests from revision 71e0a2aeca92a4078fe1b8c76e32c88ff1929737 of the https://bitbucket.org/facebook/hg-experimental repository. A list of modifications made as part of vendoring is as follows: * "EXPERIMENTAL" added to module docstring * Imports were changed to match Mercurial style conventions * "testedwith" value was updated to core Mercurial special value and comment boilerplate was inserted * A "clone_sparse" function was renamed to "clonesparse" to appease the style checker * Paths to the sparse extension in tests reflect built-in location * test-sparse-extensions.t was renamed to test-sparse-fsmonitor.t and references to "simplecache" were removed. The test always skips because it isn't trivial to run it given the way we currently run fsmonitor tests * A double empty line was removed from test-sparse-profiles.t There are aspects of the added code that are obviously not ideal. The goal is to make a minimal number of modifications as part of the vendoring to make it easier to track changes from the original implementation. Refactoring will occur in subsequent patches.

     1

test sparse

     2

     3

  $ cat >> $HGRCPATH << EOF

     4

  > [ui]

     5

  > ssh = python "$RUNTESTDIR/dummyssh"

     6

  > username = nobody <no.reply@fb.com>

     7

  > [extensions]

     8

  > sparse=

     9

  > purge=

    10

  > strip=

    11

  > rebase=

    12

  > EOF

    13

    14

  $ hg init myrepo

    15

  $ cd myrepo

    16

  $ echo a > index.html

    17

  $ echo x > data.py

    18

  $ echo z > readme.txt

    19

  $ cat > webpage.sparse <<EOF

    20

  > [include]

    21

  > *.html

    22

  > EOF

    23

  $ cat > backend.sparse <<EOF

    24

  > [include]

    25

  > *.py

    26

  > EOF

    27

  $ hg ci -Aqm 'initial'

    28

  $ cd ..

    29

    30

Verify local clone with a sparse profile works

    31

    32

  $ hg clone --enable-profile webpage.sparse myrepo clone1

    33

  updating to branch default

    34

  warning: sparse profile 'webpage.sparse' not found in rev 000000000000 - ignoring it

    35

  1 files updated, 0 files merged, 0 files removed, 0 files unresolved

    36

  $ cd clone1

    37

  $ ls

    38

  index.html

    39

  $ cd ..

    40

    41

Verify local clone with include works

    42

    43

  $ hg clone --include *.sparse myrepo clone2

    44

  updating to branch default

    45

  2 files updated, 0 files merged, 0 files removed, 0 files unresolved

    46

  $ cd clone2

    47

  $ ls

    48

  backend.sparse

    49

  webpage.sparse

    50

  $ cd ..

    51

    52

Verify local clone with exclude works

    53

    54

  $ hg clone --exclude data.py myrepo clone3

    55

  updating to branch default

    56

  4 files updated, 0 files merged, 0 files removed, 0 files unresolved

    57

  $ cd clone3

    58

  $ ls

    59

  backend.sparse

    60

  index.html

    61

  readme.txt

    62

  webpage.sparse

    63

  $ cd ..

    64

    65

Verify sparse clone profile over ssh works

    66

    67

  $ hg clone -q --enable-profile webpage.sparse ssh://user@dummy/myrepo clone4

    68

  warning: sparse profile 'webpage.sparse' not found in rev 000000000000 - ignoring it

    69

  $ cd clone4

    70

  $ ls

    71

  index.html

    72

  $ cd ..