checkout/__test__/git-source-provider.test.ts at ed69f3bbdd331f561e02e4ba566bb550e2ea906b · actions/checkout · GitHub

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
import * as core from '@actions/core'
import {adjustFetchDepthForCache} from '../src/git-source-provider'

// Mock @actions/core
jest.mock('@actions/core')

describe('adjustFetchDepthForCache', () => {
  beforeEach(() => {
    jest.clearAllMocks()
  })

  it('does nothing when referenceCache is not set', () => {
    const settings = {
      referenceCache: '',
      fetchDepth: 1,
      fetchDepthExplicit: false
    }
    adjustFetchDepthForCache(settings)
    expect(settings.fetchDepth).toBe(1)
    expect(core.warning).not.toHaveBeenCalled()
    expect(core.info).not.toHaveBeenCalled()
  })

  it('overrides fetchDepth to 0 when referenceCache is set and fetchDepth is default', () => {
    const settings = {
      referenceCache: '/cache/git-reference-cache',
      fetchDepth: 1,
      fetchDepthExplicit: false
    }
    adjustFetchDepthForCache(settings)
    expect(settings.fetchDepth).toBe(0)
    expect(core.info).toHaveBeenCalledWith(
      expect.stringContaining('Overriding fetch-depth from 1 to 0')
    )
    expect(core.warning).not.toHaveBeenCalled()
  })

  it('warns but keeps fetchDepth when referenceCache is set and fetchDepth is explicit', () => {
    const settings = {
      referenceCache: '/cache/git-reference-cache',
      fetchDepth: 1,
      fetchDepthExplicit: true
    }
    adjustFetchDepthForCache(settings)
    expect(settings.fetchDepth).toBe(1)
    expect(core.warning).toHaveBeenCalledWith(
      expect.stringContaining("'fetch-depth: 1' is set with reference-cache enabled")
    )
    expect(core.info).not.toHaveBeenCalled()
  })

  it('does nothing when referenceCache is set and fetchDepth is already 0 (explicit)', () => {
    const settings = {
      referenceCache: '/cache/git-reference-cache',
      fetchDepth: 0,
      fetchDepthExplicit: true
    }
    adjustFetchDepthForCache(settings)
    expect(settings.fetchDepth).toBe(0)
    expect(core.warning).not.toHaveBeenCalled()
    expect(core.info).not.toHaveBeenCalled()
  })

  it('does nothing when referenceCache is set and fetchDepth is already 0 (default)', () => {
    const settings = {
      referenceCache: '/cache/git-reference-cache',
      fetchDepth: 0,
      fetchDepthExplicit: false
    }
    adjustFetchDepthForCache(settings)
    expect(settings.fetchDepth).toBe(0)
    expect(core.warning).not.toHaveBeenCalled()
    expect(core.info).not.toHaveBeenCalled()
  })

  it('warns with correct depth value when explicit fetchDepth is > 1', () => {
    const settings = {
      referenceCache: '/cache/git-reference-cache',
      fetchDepth: 42,
      fetchDepthExplicit: true
    }
    adjustFetchDepthForCache(settings)
    expect(settings.fetchDepth).toBe(42)
    expect(core.warning).toHaveBeenCalledWith(
      expect.stringContaining("'fetch-depth: 42' is set with reference-cache enabled")
    )
  })
})