Skip to content
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

Jump to bottom

Clear registry cache using fpm clean --registry-cache #949

Merged
merged 6 commits into from
Mar 23, 2024
Merged

Clear registry cache using fpm clean --registry-cache #949

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e64753c
Throw error when both --skip and --all were specified, rename clean_c…
minhqdao Jun 22, 2023
ae27097
Add option for clearing the registry cache
minhqdao Jun 22, 2023
cc2a568
Add test
minhqdao Jun 22, 2023
56da54f
Add to fpm clean
minhqdao Jun 22, 2023
f83762a
Check allocation status before allocating
minhqdao Jun 22, 2023
7874665
check
henilp105 Mar 23, 2024
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
20 changes: 15 additions & 5 deletions src/fpm.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ module fpm
& stderr => error_unit
use iso_c_binding, only: c_char, c_ptr, c_int, c_null_char, c_associated, c_f_pointer
use fpm_environment, only: os_is_unix
use fpm_settings, only: fpm_global_settings, get_global_settings

implicit none
private
Expand Down Expand Up @@ -678,21 +679,30 @@ subroutine delete_skip(is_unix)
end do
end subroutine delete_skip

!> Delete the build directory including or excluding dependencies.
!> Delete the build directory including or excluding dependencies. Can be used
!> to clear the registry cache.
subroutine cmd_clean(settings)
!> Settings for the clean command.
class(fpm_clean_settings), intent(in) :: settings

character :: user_response
type(fpm_global_settings) :: global_settings
type(error_t), allocatable :: error

! Clear registry cache
if (settings%registry_cache) then
call get_global_settings(global_settings, error)
if (allocated(error)) return

call os_delete_dir(os_is_unix(), global_settings%registry_settings%cache_path)
end if

if (is_dir('build')) then
! Remove the entire build directory
if (settings%clean_call) then
if (settings%clean_all) then
call os_delete_dir(os_is_unix(), 'build'); return
end if

! Remove the build directory but skip dependencies
if (settings%clean_skip) then
else if (settings%clean_skip) then
call delete_skip(os_is_unix()); return
end if

Expand Down
45 changes: 32 additions & 13 deletions src/fpm_command_line.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ module fpm_command_line

type, extends(fpm_cmd_settings) :: fpm_clean_settings
logical :: clean_skip = .false.
logical :: clean_call = .false.
logical :: clean_all = .false.
logical :: registry_cache = .false.
end type

type, extends(fpm_build_settings) :: fpm_publish_settings
Expand Down Expand Up @@ -603,14 +604,27 @@ subroutine get_command_line_settings(cmd_settings)

case('clean')
call set_args(common_args // &
& ' --registry-cache' // &
& ' --skip' // &
& ' --all', &
help_clean, version_text)
allocate(fpm_clean_settings :: cmd_settings)
call get_current_directory(working_dir, error)
cmd_settings=fpm_clean_settings( &
& clean_skip=lget('skip'), &
& clean_call=lget('all'))

block
logical :: skip, clean_all

skip = lget('skip')
clean_all = lget('all')

if (all([skip, clean_all])) then
call fpm_stop(6, 'Do not specify both --skip and --all options on the clean subcommand.')
end if

allocate(fpm_clean_settings :: cmd_settings)
cmd_settings = fpm_clean_settings( &
& registry_cache=lget('registry-cache'), &
& clean_skip=skip, &
& clean_all=clean_all)
end block

case('publish')
call set_args(common_args // compiler_args //'&
Expand Down Expand Up @@ -750,7 +764,7 @@ subroutine set_help()
' [--list] [--compiler COMPILER_NAME] [-- ARGS] ', &
' install [--profile PROF] [--flag FFLAGS] [--no-rebuild] [--prefix PATH] ', &
' [options] ', &
' clean [--skip] [--all] ', &
' clean [--skip] [--all] [--registry-cache] ', &
' publish [--token TOKEN] [--show-package-version] [--show-upload-data] ', &
' [--dry-run] [--verbose] ', &
' ']
Expand Down Expand Up @@ -875,7 +889,7 @@ subroutine set_help()
' list [--list] ', &
' install [--profile PROF] [--flag FFLAGS] [--no-rebuild] [--prefix PATH] ', &
' [options] ', &
' clean [--skip] [--all] ', &
' clean [--skip] [--all] [--registry-cache] ', &
' publish [--token TOKEN] [--show-package-version] [--show-upload-data] ', &
' [--dry-run] [--verbose] ', &
' ', &
Expand All @@ -887,12 +901,15 @@ subroutine set_help()
help_text_flag, &
' --list List candidates instead of building or running them. On ', &
' the fpm(1) command this shows a brief list of subcommands.', &
' --runner CMD Provides a command to prefix program execution paths. ', &
' --runner CMD Provides a command to prefix program execution paths. ', &
' -- ARGS Arguments to pass to executables. ', &
' --skip Delete directories in the build/ directory without ', &
' prompting, but skip dependencies. ', &
' prompting, but skip dependencies. Cannot be used together ', &
' with --all. ', &
' --all Delete directories in the build/ directory without ', &
' prompting, including dependencies. ', &
' prompting, including dependencies. Cannot be used together', &
' with --skip. ', &
' --registry-cache Delete registry cache. ', &
' ', &
'VALID FOR ALL SUBCOMMANDS ', &
' --help Show help text and exit ', &
Expand Down Expand Up @@ -1350,10 +1367,12 @@ subroutine set_help()
'DESCRIPTION', &
' Prompts the user to confirm deletion of the build. If affirmative,', &
' directories in the build/ directory are deleted, except dependencies.', &
' Use the --registry-cache option to delete the registry cache.', &
'', &
'OPTIONS', &
' --skip delete the build without prompting but skip dependencies.', &
' --all delete the build without prompting including dependencies.', &
' --skip Delete the build without prompting but skip dependencies.', &
' --all Delete the build without prompting including dependencies.', &
' --registry-cache Delete registry cache.', &
'' ]
help_publish=[character(len=80) :: &
'NAME', &
Expand Down
2 changes: 1 addition & 1 deletion src/fpm_settings.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ subroutine get_global_settings(global_settings, error)
subroutine use_default_registry_settings(global_settings)
type(fpm_global_settings), intent(inout) :: global_settings

allocate (global_settings%registry_settings)
if (.not. allocated(global_settings%registry_settings)) allocate (global_settings%registry_settings)
global_settings%registry_settings%url = official_registry_base_url
global_settings%registry_settings%cache_path = join_path(global_settings%path_to_config_folder_or_empty(), &
& 'dependencies')
Expand Down
14 changes: 11 additions & 3 deletions test/cli_test/cli_test.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,15 @@ program main
logical :: w_t,act_w_t ; namelist/act_cli/act_w_t
logical :: c_s,act_c_s ; namelist/act_cli/act_c_s
logical :: c_a,act_c_a ; namelist/act_cli/act_c_a
logical :: reg_c,act_reg_c ; namelist/act_cli/act_reg_c
logical :: show_v,act_show_v ; namelist/act_cli/act_show_v
logical :: show_u_d,act_show_u_d; namelist/act_cli/act_show_u_d
logical :: dry_run,act_dry_run ; namelist/act_cli/act_dry_run
character(len=:), allocatable :: token, act_token ; namelist/act_cli/act_token

character(len=:), allocatable :: profile,act_profile ; namelist/act_cli/act_profile
character(len=:), allocatable :: args,act_args ; namelist/act_cli/act_args
namelist/expected/cmd,cstat,estat,w_e,w_t,c_s,c_a,name,profile,args,show_v,show_u_d,dry_run,token
namelist/expected/cmd,cstat,estat,w_e,w_t,c_s,c_a,reg_c,name,profile,args,show_v,show_u_d,dry_run,token
integer :: lun
logical,allocatable :: tally(:)
logical,allocatable :: subtally(:)
Expand Down Expand Up @@ -75,6 +76,7 @@ program main
'CMD="clean", NAME=, ARGS="",', &
'CMD="clean --skip", C_S=T, NAME=, ARGS="",', &
'CMD="clean --all", C_A=T, NAME=, ARGS="",', &
'CMD="clean --registry-cache", REG_C=T, NAME=, ARGS="",', &
'CMD="publish --token abc --show-package-version", SHOW_V=T, NAME=, token="abc",ARGS="",', &
'CMD="publish --token abc --show-upload-data", SHOW_U_D=T, NAME=, token="abc",ARGS="",', &
'CMD="publish --token abc --dry-run", DRY_RUN=T, NAME=, token="abc",ARGS="",', &
Expand Down Expand Up @@ -111,6 +113,7 @@ program main
w_t=.false. ! --test
c_s=.false. ! --skip
c_a=.false. ! --all
reg_c=.false. ! --registry-cache
show_v=.false. ! --show-package-version
show_u_d=.false. ! --show-upload-data
dry_run=.false. ! --dry-run
Expand All @@ -134,6 +137,7 @@ program main
act_w_t=.false.
act_c_s=.false.
act_c_a=.false.
act_reg_c=.false.
act_show_v=.false.
act_show_u_d=.false.
act_dry_run=.false.
Expand All @@ -148,6 +152,9 @@ program main
subtally=[logical ::]
call test_test('NAME',all(act_name==name))
call test_test('PROFILE',act_profile==profile)
call test_test('SKIP',act_c_s.eqv.c_s)
call test_test('ALL',act_c_a.eqv.c_a)
call test_test('REGISTRY-CACHE',act_reg_c.eqv.reg_c)
call test_test('WITH_EXPECTED',act_w_e.eqv.w_e)
call test_test('WITH_TESTED',act_w_t.eqv.w_t)
call test_test('WITH_TEST',act_w_t.eqv.w_t)
Expand Down Expand Up @@ -241,6 +248,7 @@ subroutine parse()
act_w_t=.false.
act_c_s=.false.
act_c_a=.false.
act_reg_c=.false.
act_show_v=.false.
act_show_u_d=.false.
act_dry_run=.false.
Expand All @@ -264,7 +272,8 @@ subroutine parse()
if (allocated(settings%args)) act_args=settings%args
type is (fpm_clean_settings)
act_c_s=settings%clean_skip
act_c_a=settings%clean_call
act_c_a=settings%clean_all
act_reg_c=settings%registry_cache
type is (fpm_install_settings)
type is (fpm_publish_settings)
act_show_v=settings%show_package_version
Expand All @@ -275,7 +284,6 @@ subroutine parse()

open(file='_test_cli',newunit=lun,delim='quote')
write(lun,nml=act_cli,delim='quote')
!!write(*,nml=act_cli)
close(unit=lun)

end subroutine parse
Expand Down