Skip to content

fix(docker): prune volume on start #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
susnux wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −1
Open

fix(docker): prune volume on start #1087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion lib/docker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import { User } from './User.ts'

const SERVER_IMAGE = 'ghcr.io/nextcloud/continuous-integration-shallow-server'

/** Named volume mounted at `/var/www/html/apps-writable`, holds the mounted and cloned apps */
const APPS_WRITABLE_VOLUME = 'apps_writable'

// The server image ships PHP but no Composer, so it is downloaded on demand
const COMPOSER_VERSION = process.env.NEXTCLOUD_E2E_COMPOSER_VERSION || 'latest-stable'
const COMPOSER_PHAR = '/tmp/composer.phar'
Expand Down Expand Up @@ -146,6 +149,10 @@ export async function startNextcloud(branch = 'master', mountApp: boolean | stri
console.log('\nStarting Nextcloud container… 🚀')
console.log(`├─ Using branch '${branch}'`)

// The volume outlives the container, so it has to be pruned to not carry
// apps cloned for a previous run (possibly of another branch) into the new container
await pruneAppsWritableVolume()

const mounts: string[] = []
Object.entries(options.mounts ?? {})
.forEach(([server, local]) => mounts.push(`${local}:/var/www/html/${server}:ro`))
Expand Down Expand Up @@ -182,7 +189,7 @@ export async function startNextcloud(branch = 'master', mountApp: boolean | stri
ReadOnly: false,
}, {
Target: '/var/www/html/apps-writable',
Source: 'apps_writable',
Source: APPS_WRITABLE_VOLUME,
Type: 'volume',
ReadOnly: false,
}],
Expand All @@ -209,6 +216,25 @@ export async function startNextcloud(branch = 'master', mountApp: boolean | stri
}
}

/**
* Remove the `apps-writable` volume, so that a newly created container starts with an empty apps path
*
* Docker keeps the named volume around when the container is removed, meaning apps cloned by
* `configureNextcloud` would otherwise be reused - including apps of a different server branch.
*/
async function pruneAppsWritableVolume() {
try {
await docker.getVolume(APPS_WRITABLE_VOLUME).remove()
console.log('├─ Pruned the "apps-writable" volume')
} catch (error) {
// The volume does not exist (yet), nothing to prune
if ((error as { statusCode?: number }).statusCode === 404) {
return
}
throw new Error(`Unable to remove the "${APPS_WRITABLE_VOLUME}" volume`, { cause: error })
}
}

/**
*
*/
Expand Down
Loading