cli/test/unit/commands/apps/diff.unit.test.ts at 23fde12d834dd2ff6909bb7aabebc325e87cd288 · heroku/cli · 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
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
import {expect} from 'chai'
import nock from 'nock'

import AppsDiff from '../../../../src/commands/apps/diff.js'
import {runCommand} from '../../../helpers/run-command.js'

describe('apps:diff', function () {
  const app1Name = 'myapp-one'
  const app2Name = 'myapp-two'
  const slugId1 = 'slug-id-1'
  const slugId2 = 'slug-id-2'
  const sameChecksum = 'SHA256:same-checksum-for-both-apps'
  const releasesWithSlug = (slugId: string) => [{slug: {id: slugId}, status: 'succeeded'}]
  const slugBody = (checksum: string) => ({id: 'slug-1', checksum})
  const appStack = (stackName: string) => ({name: 'myapp', stack: {name: stackName}, id: 'app-id'})
  const emptyBuildpacks: Array<{buildpack: {url: string}}> = []
  const emptyAddons: Array<{addon_service: {name: string}}> = []
  const emptyFeatures: Array<{name: string; enabled: boolean}> = []

  let api: nock.Scope

  function mockNoDiffs(app1: string, app2: string, slug1: string, slug2: string) {
    const releases1 = releasesWithSlug(slug1)
    const releases2 = releasesWithSlug(slug2)
    api
      .get(`/apps/${app1}/releases`)
      .matchHeader('range', /version/)
      .reply(200, releases1)
      .get(`/apps/${app1}/slugs/${slug1}`)
      .reply(200, slugBody(sameChecksum))
      .get(`/apps/${app2}/releases`)
      .matchHeader('range', /version/)
      .reply(200, releases2)
      .get(`/apps/${app2}/slugs/${slug2}`)
      .reply(200, slugBody(sameChecksum))
      .get(`/apps/${app1}/config-vars`)
      .reply(200, {})
      .get(`/apps/${app2}/config-vars`)
      .reply(200, {})
      .get(`/apps/${app1}`)
      .reply(200, appStack('heroku-22'))
      .get(`/apps/${app2}`)
      .reply(200, appStack('heroku-22'))
      .get(`/apps/${app1}/buildpack-installations`)
      .reply(200, emptyBuildpacks)
      .get(`/apps/${app2}/buildpack-installations`)
      .reply(200, emptyBuildpacks)
      .get(`/apps/${app1}/addons`)
      .reply(200, emptyAddons)
      .get(`/apps/${app2}/addons`)
      .reply(200, emptyAddons)
      .get(`/apps/${app1}/features`)
      .reply(200, emptyFeatures)
      .get(`/apps/${app2}/features`)
      .reply(200, emptyFeatures)
  }

  beforeEach(function () {
    api = nock('https://api.heroku.com')
  })

  afterEach(function () {
    api.done()
    nock.cleanAll()
  })

  it('prints table with no diff rows when both apps are identical', async function () {
    mockNoDiffs(app1Name, app2Name, slugId1, slugId2)

    const {stdout, error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.be.undefined
    expect(stdout).to.include('property')
    expect(stdout).to.include(app1Name)
    expect(stdout).to.include(app2Name)
    expect(stdout.trim()).to.not.include('slug (checksum)')
  })

  it('includes slug (checksum) row when checksums differ', async function () {
    const checksum1 = 'SHA256:aaaaaaaa'
    const checksum2 = 'SHA256:bbbbbbbb'
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId1))
      .get(`/apps/${app1Name}/slugs/${slugId1}`).reply(200, slugBody(checksum1))
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(checksum2))
      .get(`/apps/${app1Name}/config-vars`).reply(200, {})
      .get(`/apps/${app2Name}/config-vars`).reply(200, {})
      .get(`/apps/${app1Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app2Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app1Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app2Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app1Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app2Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app1Name}/features`).reply(200, emptyFeatures)
      .get(`/apps/${app2Name}/features`).reply(200, emptyFeatures)

    const {stdout, error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.be.undefined
    expect(stdout).to.include('slug (checksum)')
    expect(stdout).to.include('SHA256:aaaaaaaa')
    expect(stdout).to.include('SHA256:bbbbbbbb')
  })

  it('includes config and stack diff rows when they differ', async function () {
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId1))
      .get(`/apps/${app1Name}/slugs/${slugId1}`).reply(200, slugBody(sameChecksum))
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(sameChecksum))
      .get(`/apps/${app1Name}/config-vars`).reply(200, {FOO: 'a', BAR: 'same'})
      .get(`/apps/${app2Name}/config-vars`).reply(200, {FOO: 'b', BAR: 'same'})
      .get(`/apps/${app1Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app2Name}`).reply(200, appStack('heroku-24'))
      .get(`/apps/${app1Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app2Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app1Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app2Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app1Name}/features`).reply(200, emptyFeatures)
      .get(`/apps/${app2Name}/features`).reply(200, emptyFeatures)

    const {stdout, error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.be.undefined
    expect(stdout).to.include('config (FOO)')
    expect(stdout).to.include('stack')
    expect(stdout).to.include('heroku-22')
    expect(stdout).to.include('heroku-24')
  })

  it('throws App not found when one app returns 404 on releases', async function () {
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(404, {id: 'not_found', message: 'Couldn\'t find that app.'})
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(sameChecksum))

    const {error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.not.be.undefined
    expect(error!.message).to.include('App not found')
    expect(error!.message).to.include(app1Name)
  })

  it('throws App not found when slug returns 404', async function () {
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId1))
      .get(`/apps/${app1Name}/slugs/${slugId1}`).reply(404, {id: 'not_found', message: 'Not found'})
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(sameChecksum))

    const {error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.not.be.undefined
    expect(error!.message).to.include('App not found')
    expect(error!.message).to.include(app1Name)
  })

  it('truncates long values to 56 chars with ellipsis', async function () {
    const longChecksum = 'SHA256:' + 'a'.repeat(60)
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId1))
      .get(`/apps/${app1Name}/slugs/${slugId1}`).reply(200, slugBody(longChecksum))
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(sameChecksum))
      .get(`/apps/${app1Name}/config-vars`).reply(200, {})
      .get(`/apps/${app2Name}/config-vars`).reply(200, {})
      .get(`/apps/${app1Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app2Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app1Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app2Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app1Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app2Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app1Name}/features`).reply(200, emptyFeatures)
      .get(`/apps/${app2Name}/features`).reply(200, emptyFeatures)

    const {stdout, error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.be.undefined
    expect(stdout).to.include('slug (checksum)')
    expect(stdout).to.match(/\.\.\./)
    expect(stdout).to.include('SHA256:')
  })

  it('shows add-on only on second app', async function () {
    const addons1 = emptyAddons
    const addons2 = [{addon_service: {name: 'heroku-postgresql'}}]
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId1))
      .get(`/apps/${app1Name}/slugs/${slugId1}`).reply(200, slugBody(sameChecksum))
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesWithSlug(slugId2))
      .get(`/apps/${app2Name}/slugs/${slugId2}`).reply(200, slugBody(sameChecksum))
      .get(`/apps/${app1Name}/config-vars`).reply(200, {})
      .get(`/apps/${app2Name}/config-vars`).reply(200, {})
      .get(`/apps/${app1Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app2Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app1Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app2Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app1Name}/addons`).reply(200, addons1)
      .get(`/apps/${app2Name}/addons`).reply(200, addons2)
      .get(`/apps/${app1Name}/features`).reply(200, emptyFeatures)
      .get(`/apps/${app2Name}/features`).reply(200, emptyFeatures)

    const {stdout, error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.be.undefined
    expect(stdout).to.include('add-on (heroku-postgresql)')
    expect(stdout).to.include('false')
    expect(stdout).to.include('true')
  })

  it('shows no slug row when both apps have no release slug', async function () {
    const releasesNoSlug = [{status: 'succeeded'}]
    api
      .get(`/apps/${app1Name}/releases`).matchHeader('range', /version/).reply(200, releasesNoSlug)
      .get(`/apps/${app2Name}/releases`).matchHeader('range', /version/).reply(200, releasesNoSlug)
      .get(`/apps/${app1Name}/config-vars`).reply(200, {})
      .get(`/apps/${app2Name}/config-vars`).reply(200, {})
      .get(`/apps/${app1Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app2Name}`).reply(200, appStack('heroku-22'))
      .get(`/apps/${app1Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app2Name}/buildpack-installations`).reply(200, emptyBuildpacks)
      .get(`/apps/${app1Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app2Name}/addons`).reply(200, emptyAddons)
      .get(`/apps/${app1Name}/features`).reply(200, emptyFeatures)
      .get(`/apps/${app2Name}/features`).reply(200, emptyFeatures)

    const {stdout, error} = await runCommand(AppsDiff, [app1Name, app2Name])

    expect(error).to.be.undefined
    expect(stdout).to.include('property')
    expect(stdout.trim()).to.not.include('slug (checksum)')
  })
})