diff --git a/src/app/components/user/UserForm.vue b/src/app/components/user/UserForm.vue
index d4a74ad4..110b99aa 100644
--- a/src/app/components/user/UserForm.vue
+++ b/src/app/components/user/UserForm.vue
@@ -14,7 +14,10 @@ const emit = defineEmits<{
'cancel': []
}>()
-const { table: { pageSize } } = useAppConfig()
+const {
+ table: { pageSize },
+ features: { repositories: { 'server-search': serverSearch } },
+} = useAppConfig()
const { currentUser } = useAuth()
const { schema } = useUserSchema(() => properties.mode)
const { preferredLanguageOptions, userRoleOptions } = useUserFormOptions()
@@ -52,6 +55,7 @@ const {
label: repository.serviceName,
value: repository.id,
}),
+ server: serverSearch,
})
setupRepoScroll(repositorySelect)
@@ -353,7 +357,8 @@ const isSelf = computed(() =>
v-model="state.repositoryRoles[index] as { label: string, value: string }"
v-model:search-term="repoSearchTerm" size="xl"
:placeholder="$t('user.placeholder.repository-name')"
- :items="repositoryNames" :loading="repoSearchStatus === 'pending'" ignore-filter
+ :items="repositoryNames" :loading="repoSearchStatus === 'pending'"
+ :ignore-filter="serverSearch"
class="flex-2"
@update:open="onRepoOpen"
/>
diff --git a/src/app/composables/forms.ts b/src/app/composables/forms.ts
index 4cc8aa34..cd144aa7 100644
--- a/src/app/composables/forms.ts
+++ b/src/app/composables/forms.ts
@@ -26,6 +26,7 @@ const useSelectMenuInfiniteScroll =
(
debounce = 300,
scrollDistance = 10,
query = {},
+ server = true,
} = options
const page = ref(1)
@@ -41,10 +42,11 @@ const useSelectMenuInfiniteScroll = (
...query,
q: searchTermDebounced.value || undefined,
p: page.value,
- l: limit,
+ l: server ? limit : -1,
})),
lazy: true,
immediate: false,
+ watch: false,
})
watch(data, (newData) => {
@@ -57,6 +59,7 @@ const useSelectMenuInfiniteScroll = (
})
watch(searchTermDebounced, () => {
+ if (!server) return
page.value = 1
hasMore.value = true
execute()
diff --git a/src/app/composables/groups.ts b/src/app/composables/groups.ts
index f49971c2..fbd79913 100644
--- a/src/app/composables/groups.ts
+++ b/src/app/composables/groups.ts
@@ -15,7 +15,11 @@ const useGroupsTable = () => {
const { t: $t } = useI18n()
const { copy } = useClipboard()
- const { table: { pageSize: pageSizeConfig } } = useAppConfig()
+ const {
+ table: { pageSize: pageSizeConfig },
+ features: { groups: { 'sort-columns': sortColumns },
+ repositories: { 'server-search': serverSearch } },
+ } = useAppConfig()
const query = computed(() => normalizeGroupsQuery(route.query))
const updateQuery = async (newQuery: Partial) => {
@@ -170,11 +174,15 @@ const useGroupsTable = () => {
},
{
accessorKey: 'id',
- header: () => sortableHeader('id'),
+ header: () => sortColumns
+ ? sortableHeader('id')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.id),
},
{
accessorKey: 'displayName',
- header: () => sortableHeader('displayName'),
+ header: () => sortColumns
+ ? sortableHeader('displayName')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.displayName),
cell: ({ row }) => {
const name: string = row.original.displayName
return h(ULink, {
@@ -188,14 +196,19 @@ const useGroupsTable = () => {
},
{
accessorKey: 'public',
- header: () => sortableHeader('public'),
+ header: () => sortColumns
+ ? sortableHeader('public')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.public),
cell: ({ row }) => (
publicStatus.value[`${row.original.public}`]
),
},
{
accessorKey: 'memberListVisibility',
- header: () => sortableHeader('memberListVisibility'),
+ header: () => sortColumns
+ ? sortableHeader('memberListVisibility')
+ : h('span', { class: 'text-xs text-default font-medium' },
+ columnNames.value.memberListVisibility),
cell: ({ row }) => (
visibilityStatus.value[row.original.memberListVisibility]
),
@@ -315,6 +328,7 @@ const useGroupsTable = () => {
} = useSelectMenuInfiniteScroll({
url: repositorySelect.url,
limit: pageSizeConfig.repositories[0],
+ server: serverSearch,
transform: repository => ({
label: repository.serviceName,
value: repository.id,
diff --git a/src/app/composables/repositories.ts b/src/app/composables/repositories.ts
index b736e821..b7bbd4ca 100644
--- a/src/app/composables/repositories.ts
+++ b/src/app/composables/repositories.ts
@@ -6,6 +6,8 @@ import { UButton, UDropdownMenu, UIcon, ULink } from '#components'
import type { ButtonProps, DropdownMenuItem, TableColumn, TableRow } from '@nuxt/ui'
+const { features: { repositories: { 'sort-columns': sortColumns } } } = useAppConfig()
+
/** Composable for managing repositories table */
const useRepositoriesTable = () => {
const route = useRoute()
@@ -68,12 +70,17 @@ const useRepositoriesTable = () => {
const columns = computed(() => [
{
accessorKey: 'id',
- header: () => sortableHeader('id'),
+ header: () => sortColumns
+ ? sortableHeader('id')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.id),
cell: ({ row }) => row.original.spConnectorId,
+ enableGlobalFilter: false,
},
{
accessorKey: 'serviceName',
- header: () => sortableHeader('serviceName'),
+ header: () => sortColumns
+ ? sortableHeader('serviceName')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.serviceName),
cell: ({ row }) => {
const name: string = row.original.serviceName
return h(ULink, {
@@ -87,7 +94,9 @@ const useRepositoriesTable = () => {
},
{
accessorKey: 'serviceUrl',
- header: () => sortableHeader('serviceUrl'),
+ header: () => sortColumns
+ ? sortableHeader('serviceUrl')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.serviceUrl),
cell: ({ row }) => {
const url: string = row.original.serviceUrl
return url
@@ -109,7 +118,10 @@ const useRepositoriesTable = () => {
},
{
accessorKey: 'entityIds',
- header: () => sortableHeader('entityIds'),
+ accessorFn: row => row.entityIds?.[0],
+ header: () => sortColumns
+ ? sortableHeader('entityIds')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.entityIds),
cell: ({ row }) => row.original.entityIds?.[0],
meta: {
class: {
diff --git a/src/app/composables/useBulk.ts b/src/app/composables/useBulk.ts
index 475dcbe5..76f5840e 100644
--- a/src/app/composables/useBulk.ts
+++ b/src/app/composables/useBulk.ts
@@ -3,12 +3,9 @@
*/
import { UBadge, UIcon } from '#components'
-import type { FetchError } from 'ofetch'
import type { BadgeProps, TableColumn } from '@nuxt/ui'
-const toast = useToast()
-
-const useBulk = () => {
+const useBulk = () => {
const currentStep = ref<'upload' | 'validate' | 'result'>('upload')
const { t: $t } = useI18n()
@@ -46,13 +43,11 @@ const useBulk = () => {
const pageSize = ref(query.value.l)
const pageNumber = ref(query.value.p)
const sortOrder = ref(query.value.d)
- const makePageInfo = (result: Ref) => {
- return computed(() => {
- const start = result.value?.offset ?? 1
- const total = result.value?.total ?? 0
- const end = Math.min(start + pageSize.value!, total)
- return `${start} - ${end} / ${total}`
- })
+ const makePageInfo = (result: Ref) => {
+ const start = result.value?.offset ?? 1
+ const total = result.value?.total ?? 0
+ const end = Math.min(start + pageSize.value!, total)
+ return `${start} - ${end} / ${total}`
}
const makeStatusFilters = () => {
@@ -149,7 +144,52 @@ const useBulk = () => {
},
},
])
+ type IndicatorColor = 'success' | 'info' | 'error' | 'warning'
+ interface Indicator {
+ title: string
+ icon: string
+ number: number
+ color: IndicatorColor
+ key: string
+ }
+ const makeIndicators = (summary: ValidationResults | ExecuteResults | undefined): Indicator[] => [
+ {
+ title: $t('bulk.status.create'),
+ icon: 'i-lucide-plus-circle',
+ number: summary?.summary.create ?? 0,
+ color: 'success',
+ key: 'create',
+ },
+ {
+ title: $t('bulk.status.update'),
+ icon: 'i-lucide-pencil',
+ number: summary?.summary.update ?? 0,
+ color: 'info',
+ key: 'update',
+ },
+ {
+ title: $t('bulk.status.delete'),
+ icon: 'i-lucide-trash-2',
+ number: summary?.summary.delete ?? 0,
+ color: 'error',
+ key: 'delete',
+ },
+ {
+ title: $t('bulk.status.skip'),
+ icon: 'i-lucide-minus-circle',
+ number: summary?.summary.skip ?? 0,
+ color: 'warning',
+ key: 'skip',
+ },
+ {
+ title: $t('bulk.status.error'),
+ icon: 'i-lucide-circle-x',
+ number: summary?.summary.error ?? 0,
+ color: 'error',
+ key: 'error',
+ },
+ ]
return {
query,
currentStep,
@@ -159,6 +199,7 @@ const useBulk = () => {
sortOrder,
columns,
makePageInfo,
+ makeIndicators,
updateQuery,
makeStatusFilters,
}
@@ -174,209 +215,27 @@ const useUserUpload = () => {
}
}
-const useValidation = ({ taskId, selectedRepository }: { taskId: Ref
+const useValidation = ({ taskId }: { taskId: Ref
selectedRepository: Ref }) => {
const { query } = useBulk()
- const validationResults = ref([])
- const missingUsers = ref([])
const selectedMissingUsers = useState>(
`selection-missing-users:${taskId}`, () => ({}),
)
- const fetchValidationResults = (url: string) => {
- return useFetch(url, {
- method: 'GET',
- query,
- lazy: true,
- server: false,
- onResponseError({ response }) {
- switch (response.status) {
- case 400: { {
- toast.add({
- title: $t('bulk.status.error'),
- description: $t('bulk.validation.fetch_failed'),
- color: 'error',
- icon: 'i-lucide-circle-x',
- }) }
- break
- }
- default:{
- handleFetchError({ response })
- break
- }
- }
- },
- })
- }
const selectedCount = computed(() => {
return Object.values(selectedMissingUsers.value).filter(value => value === true).length
})
const toggleSelection = (userId: string) => {
selectedMissingUsers.value[userId] = !selectedMissingUsers.value[userId]
}
- const temporaryFileId = ref(undefined)
- const summary = ref({
- create: 0, update: 0, delete: 0, skip: 0, error: 0,
- })
-
- const { handleFetchError } = useErrorHandling()
- const executeBulkUpdate = async (url: string) => {
- if (!taskId || !selectedRepository.value) {
- throw new Error('Missing required data')
- }
- try {
- const results = await $fetch(url, {
- method: 'POST',
- body: {
- tempFileId: temporaryFileId.value,
- repositoryId: selectedRepository.value,
- deleteUsers:
- Object.keys(selectedMissingUsers.value).filter(key => selectedMissingUsers.value[key]),
- } as ExcuteRequest,
- })
- return results
- }
- catch (error) {
- handleFetchError({ response: (error as FetchError).response! })
- return { taskId: undefined, historyId: undefined }
- }
- }
-
- const useBulkIndicators = computed(() => [
- {
- title: $t('bulk.status.create'),
- icon: 'i-lucide-plus-circle',
- number: summary.value.create ?? 0,
- color: 'success',
- key: 'create',
- },
- {
- title: $t('bulk.status.update'),
- icon: 'i-lucide-pencil',
- number: summary.value.update ?? 0,
- color: 'info',
- key: 'update',
- },
- {
- title: $t('bulk.status.delete'),
- icon: 'i-lucide-trash-2',
- number: summary.value.delete ?? 0,
- color: 'error',
- key: 'delete',
- },
- {
- title: $t('bulk.status.skip'),
- icon: 'i-lucide-minus-circle',
- number: summary.value.skip ?? 0,
- color: 'warning',
- key: 'skip',
- },
- {
- title: $t('bulk.status.error'),
- icon: 'i-lucide-circle-x',
- number: summary.value.error ?? 0,
- color: 'error',
- key: 'error',
- },
- ])
return {
- useBulkIndicators,
query,
- validationResults,
- missingUsers,
selectedMissingUsers,
selectedCount,
- summary,
taskId,
- temporaryFileId,
- fetchValidationResults,
- executeBulkUpdate,
toggleSelection,
}
}
-const useExecuteUpload = () => {
- const { query } = useBulk()
- const uploadResult = ref(undefined)
- const { handleFetchError } = useErrorHandling()
- const fetchUploadResult = async (url: string) => {
- const { data, execute } = await useFetch(url, {
- method: 'GET',
- query,
- lazy: true,
- server: false,
- onResponseError({ response }) {
- switch (response.status) {
- case 400: {
- toast.add({
- title: $t('bulk.status.error'),
- description: $t('bulk.execute.result_failed'),
- color: 'error',
- icon: 'i-lucide-circle-x',
- })
- break
- }
- default: {
- handleFetchError({ response })
- break
- }
- }
- },
- })
- return { uploadResult: data, execute }
- }
-
- const resultSummary = computed(() => ({
- create: uploadResult.value!.summary.create,
- update: uploadResult.value!.summary.update,
- delete: uploadResult.value!.summary.delete,
- skip: uploadResult.value!.summary.skip,
- error: uploadResult.value!.summary.error,
- }))
-
- const useBulkIndicators = computed(() => [
- {
- title: $t('bulk.status.create'),
- icon: 'i-lucide-plus-circle',
- number: resultSummary.value.create ?? 0,
- color: 'success',
- key: 'create',
- },
- {
- title: $t('bulk.status.update'),
- icon: 'i-lucide-pencil',
- number: resultSummary.value.update ?? 0,
- color: 'info',
- key: 'update',
- },
- {
- title: $t('bulk.status.delete'),
- icon: 'i-lucide-trash-2',
- number: resultSummary.value.delete ?? 0,
- color: 'error',
- key: 'delete',
- },
- {
- title: $t('bulk.status.skip'),
- icon: 'i-lucide-minus-circle',
- number: resultSummary.value.skip ?? 0,
- color: 'warning',
- key: 'skip',
- },
- {
- title: $t('bulk.status.error'),
- icon: 'i-lucide-circle-x',
- number: resultSummary.value.error ?? 0,
- color: 'error',
- key: 'error',
- },
- ])
- return {
- uploadResult,
- useBulkIndicators,
- fetchUploadResult,
- resultSummary,
- }
-}
-export { useBulk, useUserUpload, useValidation, useExecuteUpload }
+export { useBulk, useUserUpload, useValidation }
diff --git a/src/app/composables/useHistory.ts b/src/app/composables/useHistory.ts
index b5eb6d80..dccfdfeb 100644
--- a/src/app/composables/useHistory.ts
+++ b/src/app/composables/useHistory.ts
@@ -6,9 +6,8 @@ import type { Row } from '@tanstack/table-core'
import type { DropdownMenuItem, TableColumn } from '@nuxt/ui'
import type { DateRange } from 'reka-ui'
-const toast = useToast()
-
const useHistory = () => {
+ const toast = useToast()
const route = useRoute()
const { t: $t } = useI18n()
const { currentUser } = useAuth()
@@ -26,39 +25,10 @@ const useHistory = () => {
const sortOrder = computed(() => query.value.d)
const pageNumber = ref(query.value.p)
const pageSize = ref(query.value.l)
- const loading = ref(false)
- const downloadGroups = ref([])
- const uploadRows = ref([])
const totalItems = ref(0)
- const fileExistsCache = ref>(new Map())
-
- const checkFileExists = async (fileId: string): Promise => {
- if (fileExistsCache.value.has(fileId)) {
- return fileExistsCache.value.get(fileId)!
- }
-
- try {
- const result = await $fetch(`/api/history/files/${fileId}/exists`)
- fileExistsCache.value.set(fileId, result)
- return result
- }
- catch {
- fileExistsCache.value.set(fileId, false)
- return false
- }
- }
-
- const preloadFileExistence = async (items: DownloadHistoryData[]) => {
- const fileIds = items
- .filter(item => item.fileId)
- .map(item => item.fileId!)
-
- await Promise.all(fileIds.map(id => checkFileExists(id)))
- }
const isFileAvailable = (data: DownloadHistoryData): boolean => {
- if (!data.fileId) return false
- return fileExistsCache.value.get(data.fileId) ?? true
+ return data.fileExists
}
const uploadColumns = computed[]>(() => [
@@ -136,6 +106,24 @@ const useHistory = () => {
])
const downloadColumns = computed[]>(() => [
+ {
+ id: 'expand',
+ cell: ({ row }) =>
+ h(UButton, {
+ 'color': 'neutral',
+ 'variant': 'ghost',
+ 'icon': 'i-lucide-chevron-down',
+ 'square': true,
+ 'aria-label': 'Expand',
+ 'ui': {
+ leadingIcon: [
+ 'transition-transform',
+ row.getIsExpanded() ? 'duration-200 rotate-180' : '',
+ ],
+ },
+ 'onClick': () => { row.toggleExpanded() },
+ }),
+ },
{
accessorKey: 'timestamp',
header: () => sortableHeader('timestamp'),
@@ -149,7 +137,21 @@ const useHistory = () => {
header: () => h(
'span', { class: 'text-xs text-default font-medium' },
$t('history.operator')),
- cell: ({ row }) => row.original.operator.userName,
+ cell: ({ row }) => {
+ const name = row.original.operator.userName
+ const childrenCount = row.original.childrenCount
+ if (childrenCount && childrenCount > 0) {
+ return h('span', { class: 'inline-flex items-center gap-1' }, [
+ name,
+ h(UBadge, {
+ color: 'info',
+ variant: 'soft',
+ class: 'ml-1',
+ }, () => $t('history.re-download-count', { count: childrenCount })),
+ ])
+ }
+ return name
+ },
},
{ accessorKey: 'users',
header: () => h(
@@ -168,24 +170,26 @@ const useHistory = () => {
'span', { class: 'text-xs text-default font-medium' },
$t('history.re-download')),
cell: ({ row }) => {
- return h(UButton, {
- color: 'primary',
- variant: 'outline',
- size: 'sm',
- onClick: async () => {
- const data = row.original
- try {
- await $fetch(`/api/history/files/${data.fileId}`, { method: 'GET' })
- }
- catch {
- toast.add({
- title: $t('history.file_not_available'),
- color: 'error',
- icon: 'i-lucide-circle-x',
- })
- }
- },
- }, () => $t('history.re-download'))
+ const data = row.original
+ return isFileAvailable(data)
+ ? h(UButton, {
+ color: 'primary',
+ variant: 'outline',
+ size: 'sm',
+ onClick: async () => {
+ try {
+ await $fetch(`/api/history/files/${data.fileId}`, { method: 'GET' })
+ }
+ catch {
+ toast.add({
+ title: $t('history.file_not_available'),
+ color: 'error',
+ icon: 'i-lucide-circle-x',
+ })
+ }
+ },
+ }, () => $t('history.re-download'))
+ : h('span', { class: 'text-xs text-error' }, $t('history.expired'))
},
},
{ accessorKey: 'actions',
@@ -290,43 +294,6 @@ const useHistory = () => {
},
]
}
- const { handleFetchError } = useErrorHandling()
- const loadChildren = async (
- parentId: string,
- ) => {
- const { data } = await useFetch('/api/history/download', {
- method: 'GET',
- query: {
- i: [parentId],
- },
- onResponseError({ response }) {
- switch (response.status) {
- case 400: { {
- toast.add({
- title: $t('bulk.status.error'),
- description: $t('bulk.execute.result_failed'),
- color: 'error',
- icon: 'i-lucide-circle-x',
- }) }
- break
- }
- default:{
- handleFetchError({ response })
- break
- }
- }
- },
- })
-
- const items: DownloadHistoryData[] = data.value?.resources ?? []
-
- const group = downloadGroups.value.find(g => g.parent.id === parentId)
- if (!group) return
-
- group.children = [...group.children, ...items]
- const totalChildCount = group.parent.childrenCount ?? group.children.length
- group.hasMoreChildren = group.children.length < totalChildCount
- }
const togglePublicStatus = async (
id: string,
@@ -334,11 +301,13 @@ const useHistory = () => {
) => {
const body = { public: !currentPublic }
try {
- const result = await $fetch(`/api/history/${tab.value}/${id}/public-status`, {
- method: 'PUT',
- body,
- })
- return result
+ const result
+ = await $fetch(`/api/history/${tab.value}/${id}/public-status`,
+ {
+ method: 'PUT',
+ body,
+ })
+ return result.public
}
catch {
toast.add({
@@ -360,12 +329,9 @@ const useHistory = () => {
}
return {
- loading,
tab,
uploadColumns,
downloadColumns,
- downloadGroups,
- uploadRows,
totalItems,
sortOrder,
pageNumber,
@@ -373,15 +339,16 @@ const useHistory = () => {
query,
makePageInfo,
updateQuery,
- loadChildren,
- preloadFileExistence,
togglePublicStatus,
isFileAvailable,
}
}
const useHistoryFilter = () => {
- const { table: { pageSize: pageSizeConfig } } = useAppConfig()
+ const {
+ table: { pageSize: pageSizeConfig },
+ features: { repositories: { 'server-search': serverSearch } },
+ } = useAppConfig()
const { t: $t } = useI18n()
const { query, updateQuery, tab } = useHistory()
@@ -416,6 +383,7 @@ const useHistoryFilter = () => {
} = useSelectMenuInfiniteScroll({
url: repositorySelect.url,
limit: pageSizeConfig.repositories[0],
+ server: serverSearch,
transform: repository => ({
label: repository.serviceName,
value: repository.id,
@@ -558,11 +526,9 @@ const useHistoryFilter = () => {
const targetLabel = computed(() =>
tab.value === 'download' ? $t('history.target', 1) : $t('history.target', 2),
)
- const loading = ref(false)
return {
query,
- loading,
tab,
isFiltered,
updateQuery,
diff --git a/src/app/composables/users.ts b/src/app/composables/users.ts
index d377b037..983977ab 100644
--- a/src/app/composables/users.ts
+++ b/src/app/composables/users.ts
@@ -18,7 +18,11 @@ const useUsersTable = () => {
const { t: $t } = useI18n()
const { copy } = useClipboard()
- const { table: { pageSize: pageSizeConfig } } = useAppConfig()
+ const {
+ table: { pageSize: pageSizeConfig },
+ features: { users: { 'sort-columns': sortColumns, 'file-upload': fileUpload },
+ repositories: { 'server-search': serverSearch } },
+ } = useAppConfig()
/** Reactive query object */
const query = computed(() => normalizeUsersQuery(route.query))
@@ -35,8 +39,8 @@ const useUsersTable = () => {
const searchTerm = ref(query.value.q)
const specifiedIds = ref(query.value.i)
const specifiedRepos = ref(query.value.r)
- const specifiedGroups = ref(query.value.g)
- const specifiedRoles = ref(query.value.a)
+ const specifiedGroups = computed(() => query.value.g)
+ const specifiedRoles = computed(() => query.value.a)
const startDate = ref(query.value.s)
const endDate = ref(query.value.e)
const sortKey = computed(() => query.value.k)
@@ -113,22 +117,32 @@ const useUsersTable = () => {
}))
/** Returns action buttons for a user entry */
- const creationButtons = computed<[ButtonProps, ...ButtonProps[]]>(() => [
- {
- icon: 'i-lucide-user-plus',
- label: $t('button.create-new'),
- to: '/users/new',
- color: 'primary',
- variant: 'solid',
- },
- {
- icon: 'i-lucide-file-up',
- label: $t('button.upload'),
- to: '/bulk',
- color: 'primary',
- variant: 'solid',
- },
- ])
+ const creationButtons = computed<[ButtonProps, ...ButtonProps[]]>(() => fileUpload
+ ? [
+ {
+ icon: 'i-lucide-user-plus',
+ label: $t('button.create-new'),
+ to: '/users/new',
+ color: 'primary',
+ variant: 'solid',
+ },
+ {
+ icon: 'i-lucide-file-up',
+ label: $t('button.upload'),
+ to: '/bulk',
+ color: 'primary',
+ variant: 'solid',
+ },
+ ]
+ : [
+ {
+ icon: 'i-lucide-user-plus',
+ label: $t('button.create-new'),
+ to: '/users/new',
+ color: 'primary',
+ variant: 'solid',
+ },
+ ])
/** Actions to display when the list is empty */
const emptyActions = computed<[ButtonProps, ...ButtonProps[]]>(() => [
@@ -210,11 +224,15 @@ const useUsersTable = () => {
},
{
accessorKey: 'id',
- header: () => sortableHeader('id'),
+ header: () => sortColumns
+ ? sortableHeader('id')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.id),
},
{
accessorKey: 'userName',
- header: () => sortableHeader('userName'),
+ header: () => sortColumns
+ ? sortableHeader('userName')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.userName),
cell: ({ row }) => {
const name = row.original.userName
const role = camelCase(row.original.role!)
@@ -266,17 +284,23 @@ const useUsersTable = () => {
},
{
accessorKey: 'emails',
- header: () => sortableHeader('emails'),
+ header: () => sortColumns
+ ? sortableHeader('emails')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.emails),
cell: ({ row }) => row.original.emails?.[0] ?? '',
},
{
accessorKey: 'eppns',
- header: () => sortableHeader('eppns'),
+ header: () => sortColumns
+ ? sortableHeader('eppns')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.eppns),
cell: ({ row }) => row.original.eppns?.[0] ?? '',
},
{
accessorKey: 'lastModified',
- header: () => sortableHeader('lastModified'),
+ header: () => sortColumns
+ ? sortableHeader('lastModified')
+ : h('span', { class: 'text-xs text-default font-medium' }, columnNames.value.lastModified),
cell: ({ row }) =>
row.original.lastModified
? datetimeFormatter.format(new Date(row.original.lastModified))
@@ -405,6 +429,7 @@ const useUsersTable = () => {
} = useSelectMenuInfiniteScroll({
url: repositorySelect.url,
limit: pageSizeConfig.repositories[0],
+ server: serverSearch,
transform: repository => ({
label: repository.serviceName,
value: repository.id,
@@ -507,6 +532,14 @@ const useUsersTable = () => {
})
}
+ const isRoleFilterActive = computed(() => {
+ return specifiedRoles.value && specifiedRoles.value.length > 0
+ })
+
+ const isGroupFilterActive = computed(() => {
+ return specifiedGroups.value && specifiedGroups.value.length > 0
+ })
+
return {
/** Computed reference for the current query */
query,
@@ -570,6 +603,10 @@ const useUsersTable = () => {
},
/** Make indicator for the page information */
makePageInfo,
+ /** Indicator for whether the group filter is active */
+ isGroupFilterActive,
+ /** Indicator for whether the role filter is active */
+ isRoleFilterActive,
/** Reactive object for the state of modals */
modals,
}
diff --git a/src/app/i18n/locales/en.json b/src/app/i18n/locales/en.json
index 4aa0724e..bc2d2034 100644
--- a/src/app/i18n/locales/en.json
+++ b/src/app/i18n/locales/en.json
@@ -1,10 +1,10 @@
{
"bulk": {
"about": "About bulk operations",
- "about-description": "Users included in the file are newly registered or updated",
- "about-description2": "Existing users are matched by id and updated if they match",
- "about-description3": "You can choose to delete users who are not included in the file",
- "about-description4": "Supported formats: TSV, CSV, Excel",
+ "about-description": "Users included in the file are newly registered or updated.",
+ "about-description2": "Existing users are matched by id and updated if they match.",
+ "about-description3": "You can choose to delete users who are not included in the file.",
+ "about-description4": "Supported formats: TSV, CSV, Excel.",
"column": {
"email": "E-mail",
"eppn": "ePPN",
@@ -20,12 +20,13 @@
"excute": {
},
"execute": {
- "failed": "User update failed",
- "result_failed": "Failed to get execution results"
+ "failed": "User update failed.",
+ "result_failed": "Failed to get execution results.",
+ "timeout": "Bulk update process timed out."
},
"file-format-error": "The file format is not supported. \nChoose TSV, CSV, or Excel file.",
- "file-required": "Please select file",
- "file-validate-error": "File validation failed",
+ "file-required": "Please select file.",
+ "file-validate-error": "File validation failed.",
"filter": "filter",
"import": {
},
@@ -36,9 +37,10 @@
"select": "Please select the user to delete."
},
"missing_user": "User not included in file",
+ "no-results": "Data not found.",
"operator": "Execution user",
- "repository-required": "Please select a repository",
- "select-repository": "Please select a repository",
+ "repository-required": "Please select a repository.",
+ "select-repository": "Please select a repository.",
"select_all": "Select all",
"start-at": "Start date and time",
"status": {
@@ -65,11 +67,13 @@
"upload-file": "upload file",
"upload-file-info": "Batch operation results",
"validation": {
- "error": "Invalid data detected",
+ "error": "Invalid data detected.",
"error-detail": "Please correct the file and upload it again.",
- "fetch_failed": "Failed to obtain verification results",
- "fix_error": "Please fix the error",
- "results": "data preview"
+ "failed": "File validation failed.",
+ "fetch_failed": "Failed to obtain verification results.",
+ "fix_error": "Please fix the error.",
+ "results": "data preview",
+ "timeout": "File validation timed out."
},
"view-all": "Show all"
},
@@ -104,7 +108,13 @@
}
},
"error-page": {
+ "failed": {
+ "bulk-validation": "File validation failed",
+ "load-more": "Failed to retrieve download history again"
+ },
"forbidden": {
+ "bulk-edit": "You do not have permission to work with users of this repository.",
+ "bulk-result": "You do not have permission to view upload history.",
"group-access": "You do not have permission to access this group.",
"group-create": "You do not have permission to create groups in the selected repository.",
"group-delete": "You do not have permission to delete this group.",
@@ -118,6 +128,8 @@
"user-edit": "You do not have permission to change this user's information."
},
"not-found": {
+ "bulk-result": "No matching upload history was found.",
+ "bulk-validation": "File verification results not found",
"group": "No such group found.",
"repository": "No such repository found.",
"user": "No such user found."
@@ -206,8 +218,8 @@
"public": "Public Status",
"users-count": "Users"
},
+ "search-placeholder": "Search by group name...",
"no-groupss-description": "Your repository does not have any groups. Please create a group first.",
- "search-placeholder": "Seach...",
"title": "Groups List"
},
"title": "Groups"
@@ -231,14 +243,15 @@
"download": {
"date": "Download date and time"
},
- "empty": "No data matching your search criteria was found",
- "empty-data": "No data",
+ "empty": "No data matching your search criteria was found.",
+ "empty-data": "No data.",
"expired": "Expired",
"failed": "failure",
"failed-count": "Number of failures",
"file": "file",
+ "file_not_available": "File download failed.",
"filter": {
- "options_not_found": "Failed to get filter",
+ "options_not_found": "Failed to get filter.",
"title": "filter"
},
"first-download": "First download",
@@ -250,7 +263,7 @@
"progress": "Processing",
"public": "Make it public",
"re-download": "re-download",
- "re-download-count": "Re-DL",
+ "re-download-count": "Re-DL: {count} times",
"reset": "reset",
"show-detail": "Show details",
"status": "status",
@@ -274,6 +287,7 @@
"table-title": "History list",
"target": "Download target | Upload target",
"title": "History",
+ "toggle_public_status_failed": "Failed to update publishing status.",
"unavailable": "Expired",
"upload": {
"date": "Upload date and time"
@@ -332,6 +346,8 @@
},
"no-repositories-description": "you have no repositories to manage",
"no-repositories-title": "No repositories found",
+ "search-placeholder": "Search by repository name, URL, EntityID...",
+ "search-placeholder-service-name-only": "Search by repository name...",
"title": "Repositories List"
},
"title": "Repositories",
@@ -598,6 +614,10 @@
}
},
"users": {
+ "alert": {
+ "filter-by-both-role-group-disabled": "Currently, due to limited functionality, it is not possible to select role and group filters at the same time.",
+ "filter-by-last-modified-disabled": "Due to limited functionality, filtering by last updated time is currently not available."
+ },
"all-users-actions": "All users",
"button": {
"all-users-download": "Download all users",
@@ -626,7 +646,8 @@
},
"no-users-description": "Your repository does not have any users. Please create a user or upload a file first.",
"no-users-title": "No users found",
- "search-placeholder": "Search...",
+ "search-placeholder": "Search by username, email, ePPN...",
+ "search-placeholder-username-only": "Search by username...",
"title": "Users List"
},
"title": "Users"
diff --git a/src/app/i18n/locales/ja.json b/src/app/i18n/locales/ja.json
index 74f54442..9c21aef2 100644
--- a/src/app/i18n/locales/ja.json
+++ b/src/app/i18n/locales/ja.json
@@ -2,8 +2,8 @@
"bulk": {
"about": "一括操作について",
"about-description": "ファイルに含まれるユーザーは新規登録または更新されます。",
- "about-description2": "既存ユーザーはidで照合し、一致する場合は更新されます",
- "about-description3": "ファイルに含まれていないユーザーの削除を選択できます",
+ "about-description2": "既存ユーザーはidで照合し、一致する場合は更新されます。",
+ "about-description3": "ファイルに含まれていないユーザーの削除を選択できます。",
"about-description4": "対応形式: TSV, CSV, Excel",
"column": {
"email": "E-maile",
@@ -20,12 +20,13 @@
"excute": {
},
"execute": {
- "failed": "ユーザーの更新に失敗しました",
- "result_failed": "実行結果の取得に失敗しました"
+ "failed": "ユーザーの更新に失敗しました。",
+ "result_failed": "実行結果の取得に失敗しました。",
+ "timeout": "一括更新処理がタイムアウトしました。"
},
"file-format-error": "対応していないファイル形式です。TSV、CSV、またはExcelファイルを選択してください。",
- "file-required": "ファイルを選択してください",
- "file-validate-error": "ファイルの検証に失敗しました",
+ "file-required": "ファイルを選択してください。",
+ "file-validate-error": "ファイルの検証に失敗しました。",
"filter": "フィルター",
"import": {
},
@@ -36,9 +37,10 @@
"select": "削除するユーザーを選択してください。"
},
"missing_user": "ファイルに含まれていないユーザー",
+ "no-results": "データが見つかりません。",
"operator": "実行ユーザー",
- "repository-required": "リポジトリを選択してください",
- "select-repository": "リポジトリを選択してください",
+ "repository-required": "リポジトリを選択してください。",
+ "select-repository": "リポジトリを選択してください。",
"select_all": "すべて選択",
"start-at": "開始日時",
"status": {
@@ -65,11 +67,13 @@
"upload-file": "アップロードファイル",
"upload-file-info": "一括操作結果",
"validation": {
- "error": "不正なデータが検出されました",
+ "error": "不正なデータが検出されました。",
"error-detail": "ファイルを修正して再度アップロードしてください。",
- "fetch_failed": "検証結果の取得に失敗しました",
- "fix_error": "エラーを修正してください",
- "results": "データプレビュー"
+ "failed": "ファイルの検証に失敗しました。",
+ "fetch_failed": "検証結果の取得に失敗しました。",
+ "fix_error": "エラーを修正してください。",
+ "results": "データプレビュー",
+ "timeout": "ファイルの検証がタイムアウトしました。"
},
"view-all": "すべて表示"
},
@@ -94,7 +98,13 @@
"loading": "読み込み中..."
},
"error-page": {
+ "failed": {
+ "bulk-validation": "ファイルの検証に失敗しました",
+ "load-more": "再ダウンロード履歴の取得に失敗しました"
+ },
"forbidden": {
+ "bulk-edit": "このリポジトリのユーザーを操作する権限がありません。",
+ "bulk-result": "アップロード履歴を閲覧する権限がありません。",
"group-access": "このグループにアクセスする権限がありません。",
"group-create": "選択したリポジトリにグループを作成する権限がありません。",
"group-delete": "このグループを削除する権限がありません。",
@@ -108,6 +118,8 @@
"user-edit": "このユーザーの情報を変更する権限がありません。"
},
"not-found": {
+ "bulk-result": "該当するアップロード履歴が見つかりません。",
+ "bulk-validation": "ファイルの検証結果が見つかりません",
"group": "該当するグループが見つかりません。",
"repository": "該当するリポジトリが見つかりません。",
"user": "該当するユーザーが見つかりません。"
@@ -192,8 +204,8 @@
"public": "グループの公開状態",
"users-count": "ユーザー数"
},
+ "search-placeholder": "グループ名で検索...",
"no-groupss-description": "あなたのリポジトリにはグループがありません。まずはグループを作成してください。",
- "search-placeholder": "検索...",
"title": "グループ一覧"
},
"title": "グループ"
@@ -216,14 +228,15 @@
"download": {
"date": "ダウンロード日時"
},
- "empty": "検索条件に一致するデータが見つかりませんでした",
- "empty-data": "データがありません",
+ "empty": "検索条件に一致するデータが見つかりませんでした。",
+ "empty-data": "データがありません。",
"expired": "期限切れ",
"failed": "失敗",
"failed-count": "失敗件数",
"file": "ファイル",
+ "file_not_available": "ファイルのダウンロードに失敗しました。",
"filter": {
- "options_not_found": "フィルターの取得に失敗しました",
+ "options_not_found": "フィルターの取得に失敗しました。",
"title": "フィルター"
},
"first-download": "初回ダウンロード",
@@ -235,7 +248,7 @@
"progress": "処理中",
"public": "公開にする",
"re-download": "再ダウンロード",
- "re-download-count": "再DL",
+ "re-download-count": "再DL: {count}回",
"reset": "リセット",
"show-detail": "詳細を表示",
"status": "ステータス",
@@ -259,6 +272,7 @@
"table-title": "履歴一覧",
"target": "ダウンロード対象 | アップロード対象",
"title": "履歴",
+ "toggle_public_status_failed": "公開状態の更新に失敗しました。",
"unavailable": "期限切れ",
"upload": {
"date": "アップロード日時"
@@ -317,6 +331,8 @@
},
"no-repositories-description": "あなたには管理できるリポジトリがありません",
"no-repositories-title": "リポジトリが見つかりません",
+ "search-placeholder": "リポジトリ名、URL、EntityIDで検索...",
+ "search-placeholder-service-name-only": "リポジトリ名で検索...",
"title": "リポジトリ一覧"
},
"title": "リポジトリ",
@@ -569,6 +585,10 @@
}
},
"users": {
+ "alert": {
+ "filter-by-both-role-group-disabled": "現在、機能が制限されているため、ロールとグループのフィルターを同時に選択することができません。",
+ "filter-by-last-modified-disabled": "現在、機能が制限されているため、最終更新日時によるフィルターはご利用いただけません。"
+ },
"all-users-actions": "すべてのユーザー",
"button": {
"all-users-download": "全件ダウンロード",
@@ -595,7 +615,8 @@
},
"no-users-description": "あなたのリポジトリにはユーザーがいません。まずはユーザーを作成するか、ファイルをアップロードしてください。",
"no-users-title": "ユーザーが見つかりません",
- "search-placeholder": "検索...",
+ "search-placeholder": "ユーザー名、Email、ePPN で検索...",
+ "search-placeholder-username-only": "ユーザー名で検索...",
"title": "ユーザー一覧"
},
"title": "ユーザー"
diff --git a/src/app/pages/bulk/[id].vue b/src/app/pages/bulk/[id].vue
index 7c22e0be..0817fe65 100644
--- a/src/app/pages/bulk/[id].vue
+++ b/src/app/pages/bulk/[id].vue
@@ -1,7 +1,7 @@
@@ -75,7 +78,7 @@ const handleAction = async (action: string, row: ActionRow) => {
{
:ui="{ trigger: 'min-w-50' }"
>
-
+
-
- {{ $t('common.loading') }}
-
-
+
@@ -108,21 +109,17 @@ const handleAction = async (action: string, row: ActionRow) => {
-
+
-
- {{ $t('common.loading') }}
-
-
+
diff --git a/src/app/pages/repositories/index.vue b/src/app/pages/repositories/index.vue
index d7b6f463..56803fff 100644
--- a/src/app/pages/repositories/index.vue
+++ b/src/app/pages/repositories/index.vue
@@ -11,14 +11,25 @@ const {
const { searchTerm, pageNumber, pageSize } = criteria
const table = useTemplateRef('table')
-const { table: { pageSize: { repositories: pageOptions } } } = useAppConfig()
+const {
+ table: { pageSize: { repositories: pageOptions } },
+ features: { repositories: { 'server-search': serverSearch } },
+} = useAppConfig()
+const serverQuery = computed(() => {
+ if (serverSearch) return query.value
+ const { q, l, ...remain } = query.value
+ return {
+ ...remain,
+ l: -1,
+ }
+})
const { handleFetchError } = useErrorHandling()
const {
data: searchResult, status, refresh,
} = useFetch
('/api/repositories', {
method: 'GET',
- query,
+ query: serverQuery,
onResponseError({ response }) {
switch (response.status) {
case 400: {
@@ -74,7 +85,12 @@ const pageInfo = makePageInfo(searchResult)
@@ -133,7 +149,7 @@ const pageInfo = makePageInfo(searchResult)
@@ -148,7 +164,13 @@ const pageInfo = makePageInfo(searchResult)
diff --git a/src/app/pages/users/index.vue b/src/app/pages/users/index.vue
index 25862e69..024d343f 100644
--- a/src/app/pages/users/index.vue
+++ b/src/app/pages/users/index.vue
@@ -8,12 +8,18 @@ const {
toggleSelection, selectedCount, getSelected, clearSelection, selectedUsersActions,
columns, columnNames, columnVisibility,
makeAttributeFilters, dateFilter: { dateRange, formattedDateRange }, makePageInfo, modals,
+ isRoleFilterActive, isGroupFilterActive,
} = useUsersTable()
const { searchTerm, pageNumber, pageSize } = criteria
const table = useTemplateRef('table')
-const { table: { pageSize: { users: pageOptions } } } = useAppConfig()
+const { table: { pageSize: { users: pageOptions } },
+ features: { users: { 'filter-by-last-modified': filterByLastModified,
+ 'filter-by-both-role-group': filterByBoth,
+ 'search-only-username': sercheOnlyUserName },
+ repositories: { 'server-search': serverSearch } },
+} = useAppConfig()
const { handleFetchError } = useErrorHandling()
const { data: searchResult, status, refresh } = useFetch('/api/users', {
@@ -217,7 +223,12 @@ const onRemove = async (event: FormSubmitEvent) => {
@@ -286,33 +297,74 @@ const onRemove = async (event: FormSubmitEvent) => {
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
+
@@ -330,11 +382,17 @@ const onRemove = async (event: FormSubmitEvent) => {
+
@@ -360,6 +418,7 @@ const onRemove = async (event: FormSubmitEvent) => {
{{ pageInfo }}
+
) => {
@update:page="(value) => updateQuery({ p: value })"
/>
+
diff --git a/src/app/types/bulks.ts b/src/app/types/bulks.ts
index 39c4a92a..2baf26a7 100644
--- a/src/app/types/bulks.ts
+++ b/src/app/types/bulks.ts
@@ -1,6 +1,6 @@
type StatusType = 'create' | 'update' | 'delete' | 'skip' | 'error'
-interface ValidationResult {
+interface EachResult {
row: number
id: string
status: StatusType
@@ -18,8 +18,8 @@ interface MissingUser {
groups: string[]
}
-interface ValidationSummary {
- items: ValidationResult[]
+interface ValidationResults {
+ results: EachResult[]
summary: Summary
missingUsers: MissingUser[]
total: number
@@ -27,17 +27,6 @@ interface ValidationSummary {
pageSize: number
}
-interface UploadResult {
- row: number
- id: string
- status: StatusType
- userName: string
- eppn: string[]
- emails: string[]
- groups: string[]
- code?: string
-}
-
interface Summary {
create: number
update: number
@@ -46,8 +35,8 @@ interface Summary {
error: number
}
-interface ResultSummary {
- results: UploadResult[]
+interface ExecuteResults {
+ results: EachResult[]
summary: Summary
fileInfo: {
fileName: string
@@ -92,6 +81,7 @@ interface BulkIndicator {
icon: string
key: StatusType
}
-export type { StatusType, ValidationResult, MissingUser, UploadResult, Summary, ExcuteResponse,
- BulkProcessingStatus, ValidationSummary, ResultSummary, ExcuteRequest, UploadQuery, BulkIndicator,
+export type { StatusType, EachResult, MissingUser, Summary, ExcuteResponse,
+ BulkProcessingStatus, ValidationResults, ExecuteResults, ExcuteRequest,
+ UploadQuery, BulkIndicator,
}
diff --git a/src/app/types/forms.ts b/src/app/types/forms.ts
index bc7f7f31..8aa9acd2 100644
--- a/src/app/types/forms.ts
+++ b/src/app/types/forms.ts
@@ -5,6 +5,7 @@ type UseSelectMenuInfiniteScrollOptions = {
debounce?: number
scrollDistance?: number
query?: Record
+ server?: boolean
}
type UseSelectMenuInfiniteScrollReturn = {
diff --git a/src/app/types/history.ts b/src/app/types/history.ts
index 352788cc..e8a7471a 100644
--- a/src/app/types/history.ts
+++ b/src/app/types/history.ts
@@ -9,6 +9,7 @@ interface DownloadHistoryData {
parentId: string | undefined
filePath: string
fileId: string
+ fileExists: boolean
repositoryCount: number
groupCount: number
userCount: number
@@ -56,13 +57,6 @@ interface HistoryQuery {
i?: string[]
}
-interface DownloadGroupItem {
- parent: DownloadHistoryData
- children: DownloadHistoryData[]
- hasMoreChildren: boolean
- childrenLimit: number
-}
-
interface TableConfig {
enableExpand?: boolean
showStatus?: boolean
@@ -89,8 +83,8 @@ interface PublicStatusUpdateRequest {
public: boolean
}
-type ActionRow = DownloadGroupItem | UploadHistoryData
+type ActionRow = DownloadHistoryData | UploadHistoryData
export type { DownloadHistoryData, UploadHistoryData, DownloadApiModel, UploadApiModel,
HistoryQuery, TableConfig, FilterOptionsResponse, SelectOption, StatusConfig,
- PublicStatusUpdateRequest, ActionRow, DownloadGroupItem }
+ PublicStatusUpdateRequest, ActionRow }
diff --git a/src/server/api/bulk.py b/src/server/api/bulk.py
index 2a1fa9b8..d5caf463 100644
--- a/src/server/api/bulk.py
+++ b/src/server/api/bulk.py
@@ -4,18 +4,31 @@
"""API router for bulk endpoints."""
-import typing as t
+from uuid import UUID
-from pathlib import Path
-from uuid import UUID, uuid7
-
-from flask import Blueprint
-from flask_login import current_user
+from flask import Blueprint, current_app
+from flask_login import current_user, login_required
from flask_pydantic import validate
-from redis.exceptions import ConnectionError as RedisConnectionError
-from server.api.helpers import validate_files
-from server.api.schemas import (
+from server.auth import is_user_logged_in
+from server.const import DEFAULT_SEARCH_COUNT, USER_ROLES
+from server.entities.bulk import (
+ ExecuteResults,
+ ValidateResults,
+)
+from server.exc import (
+ FileFormatError,
+ FileNotFound,
+ FileValidationError,
+ RecordNotFound,
+ TaskExcutionError,
+)
+from server.messages import E
+from server.services import bulks, history_table, repositories
+from server.services.utils import get_permitted_repository_ids, require_enabled
+
+from .helpers import roles_required, validate_files
+from .schemas import (
BulkBody,
BulkFileForm,
ErrorResponse,
@@ -23,19 +36,20 @@
TargetRepositoryForm,
UploadQuery,
)
-from server.config import config
-from server.entities.bulk import ResultSummary, ValidateSummary
-from server.entities.login_user import LoginUser
-from server.exc import RecordNotFound
-from server.services import bulks, history_table
+
+
+STATUS_MAP = {0: "create", 1: "update", 2: "delete", 3: "skip", 4: "error"}
bp = Blueprint("bulk", __name__)
@bp.post("/upload-file")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
@validate_files
@validate(response_by_alias=True)
+@require_enabled("enable_bulk_operation")
def upload_file(
form: TargetRepositoryForm, files: BulkFileForm
) -> tuple[BulkBody | ErrorResponse, int]:
@@ -49,29 +63,32 @@ def upload_file(
BulkBody: The response containing task ID
ErrorResponse: The response containing task ID or error message.
"""
- temp_id = uuid7()
- temp_dir = Path(config.STORAGE.local.temporary)
- original_filename = files.bulk_file.filename or "upload_file"
- operator_id = t.cast("LoginUser", current_user).map_id
- operator_name = t.cast("LoginUser", current_user).user_name
- new_filename = f"{temp_id}_{Path(original_filename).name}"
- file_path = temp_dir / new_filename
- files.bulk_file.save(str(file_path))
- file_content = {"repositories": [{"id": form.repository_id}]}
- history_table.create_file(
- file_id=temp_id, file_path=str(file_path), file_content=file_content
- )
-
- bulks.delete_temporary_file.apply_async((str(temp_id),), countdown=3600)
+ if repositories.get_by_id(form.repository_id) is None:
+ current_app.logger.error(E.REPOSITORY_NOT_FOUND, {"id": form.repository_id})
+ return ErrorResponse(
+ message=E.REPOSITORY_NOT_FOUND % {"id": form.repository_id}
+ ), 404
+ if (
+ not current_user.is_system_admin
+ and form.repository_id not in get_permitted_repository_ids()
+ ):
+ current_app.logger.error(E.REPOSITORY_FORBIDDEN, {"id": form.repository_id})
+ return ErrorResponse(
+ message=E.REPOSITORY_FORBIDDEN % {"id": form.repository_id}
+ ), 403
+ temp_file_id = bulks.upload_file(form.repository_id, files.bulk_file)
task = bulks.validate_upload_data.apply_async(
- (operator_id, operator_name, temp_id),
+ (current_user.map_id, current_user.user_name, temp_file_id),
session_required=True, # pyright: ignore[reportCallIssue]
)
- return BulkBody(task_id=task.id, temp_file_id=temp_id), 202
+ return BulkBody(task_id=task.id, temp_file_id=temp_file_id), 200
@bp.get("/validate/status/")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
@validate(response_by_alias=True)
+@require_enabled("enable_bulk_operation")
def validate_status(task_id: str) -> tuple[BulkBody | ErrorResponse, int]:
"""Get the status of a validation task.
@@ -83,22 +100,21 @@ def validate_status(task_id: str) -> tuple[BulkBody | ErrorResponse, int]:
ErrorResponse: The response containing task status or error message
"""
try:
- res = bulks.validate_upload_data.AsyncResult(task_id)
- except RedisConnectionError:
- error = f"Failed to connect to Redis: {task_id}"
- return ErrorResponse(code="", message=error), 500
- if not res:
- error = f"Task not found: {task_id}"
- return ErrorResponse(code="", message=error), 404
+ res = bulks.get_validate_task_result(task_id)
+ except TaskExcutionError as exc:
+ return ErrorResponse(message=exc.message), 404
return BulkBody(status=res.state), 200
@bp.get("/validate/result/")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
@validate(response_by_alias=True)
+@require_enabled("enable_bulk_operation")
def validate_result(
query: UploadQuery,
task_id: str,
-) -> tuple[ValidateSummary | ErrorResponse, int]:
+) -> tuple[ValidateResults | ErrorResponse, int]:
"""Get the result of a validation task.
Args:
@@ -110,37 +126,38 @@ def validate_result(
ErrorResponse: The response containing validation result or error message.
"""
try:
- res = bulks.validate_upload_data.AsyncResult(task_id)
- except RedisConnectionError:
- error = f"Failed to connect to Redis: {task_id}"
- return ErrorResponse(code="", message=error), 500
- if not res:
- error = f"Task not found: {task_id}"
- return ErrorResponse(code="", message=error), 404
- if not res.successful():
- error = f"Task not successful: {task_id}"
- return ErrorResponse(code="", message=error), 400
- history_id = res.result
- if isinstance(history_id, BaseException):
- error = f"Task resulted in an exception: {history_id}"
- return ErrorResponse(code="", message=error), 400
- status_filter = (
- [
- {0: "create", 1: "update", 2: "delete", 3: "skip", 4: "error"}[status]
- for status in query.f
- ]
- if query.f
- else []
- )
- offset = query.p or 1
- size = query.l or 20
- return bulks.get_validate_result(
- history_id=history_id, status_filter=status_filter, offset=offset, size=size
- ), 200
+ res = bulks.get_validate_task_result(task_id)
+ match res.result:
+ case FileNotFound():
+ return ErrorResponse(message=res.result.message), 404
+ case FileValidationError() | FileFormatError():
+ return ErrorResponse(message=res.result.message), 400
+ case UUID():
+ pass
+ case _:
+ return ErrorResponse(message=E.UNEXPECTED_SERVER_ERROR), 500
+ history_id = res.result
+ status_filter = [STATUS_MAP[status] for status in query.f] if query.f else []
+ offset = query.p or 1
+ size = query.l or DEFAULT_SEARCH_COUNT
+ if not is_user_logged_in(
+ current_user
+ ) or not bulks.chack_permission_to_operation(history_id, current_user.map_id):
+ current_app.logger.error(E.OPERATION_FORBIDDEN)
+ return ErrorResponse(message=E.OPERATION_FORBIDDEN), 403
+ result = bulks.get_validate_result(
+ history_id=history_id, status_filter=status_filter, offset=offset, size=size
+ )
+ except (RecordNotFound, TaskExcutionError) as exc:
+ return ErrorResponse(message=exc.message), 404
+ return result, 200
@bp.post("/execute")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
@validate(response_by_alias=True)
+@require_enabled("enable_bulk_operation")
def execute(body: ExcuteRequest) -> tuple[BulkBody | ErrorResponse, int]:
"""Execute a bulk upload.
@@ -155,6 +172,11 @@ def execute(body: ExcuteRequest) -> tuple[BulkBody | ErrorResponse, int]:
"""
try:
history_id = history_table.get_history_by_file_id(body.temp_file_id).id
+ if not is_user_logged_in(
+ current_user
+ ) or not bulks.chack_permission_to_operation(history_id, current_user.map_id):
+ current_app.logger.error(E.OPERATION_FORBIDDEN)
+ return ErrorResponse(message=E.OPERATION_FORBIDDEN), 403
task = bulks.update_users.apply_async(
kwargs={
"history_id": history_id,
@@ -163,12 +185,16 @@ def execute(body: ExcuteRequest) -> tuple[BulkBody | ErrorResponse, int]:
},
)
except RecordNotFound as exc:
- return ErrorResponse(code="", message=str(exc)), 404
+ return ErrorResponse(message=exc.message), 404
return BulkBody(task_id=task.id, history_id=history_id), 200
@bp.get("/execute/status/")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
+@validate(response_by_alias=True)
@validate()
+@require_enabled("enable_bulk_operation")
def execute_status(task_id: str) -> tuple[BulkBody | ErrorResponse, int]:
"""Get the status of an execution task.
@@ -180,21 +206,20 @@ def execute_status(task_id: str) -> tuple[BulkBody | ErrorResponse, int]:
ErrorResponse: The response containing task status or error message
"""
try:
- res = bulks.update_users.AsyncResult(task_id)
- except RedisConnectionError:
- error = f"Failed to connect to Redis: {task_id}"
- return ErrorResponse(code="", message=error), 500
- if not res:
- error = f"Task not found: {task_id}"
- return ErrorResponse(code="", message=error), 404
+ res = bulks.get_execute_task_result(task_id)
+ except TaskExcutionError as exc:
+ return ErrorResponse(message=exc.message), 404
return BulkBody(status=res.state), 200
@bp.get("/result/")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
@validate(response_by_alias=True)
+@require_enabled("enable_bulk_operation")
def result(
history_id: UUID, query: UploadQuery
-) -> tuple[ResultSummary | ErrorResponse, int]:
+) -> tuple[ExecuteResults | ErrorResponse, int]:
"""Get the result of a bulk upload.
Args:
@@ -202,24 +227,20 @@ def result(
query(UploadQuery): Query parameters for filtering results.
Returns:
- ResultSummary: Summary of displayed history If the get is successful
+ ExecuteResults: Summary of displayed history If the get is successful
ErrorResponse: If the get is failed
"""
- status_filter = (
- [
- {0: "create", 1: "update", 2: "delete", 3: "skip", 4: "error"}[status]
- for status in query.f
- ]
- if query.f
- else []
- )
+ status_filter = [STATUS_MAP[status] for status in query.f] if query.f else []
offset = query.p or 1
- size = query.l or 10
+ size = query.l or DEFAULT_SEARCH_COUNT
try:
+ if not bulks.chack_permission_to_view(history_id):
+ current_app.logger.error(E.OPERATION_FORBIDDEN)
+ return ErrorResponse(message=E.OPERATION_FORBIDDEN), 403
result = bulks.get_upload_result(
history_id=history_id, status_filter=status_filter, offset=offset, size=size
)
except RecordNotFound as exc:
- return ErrorResponse(code="", message=str(exc)), 404
+ return ErrorResponse(message=exc.message), 404
return result, 200
diff --git a/src/server/api/history.py b/src/server/api/history.py
index 2a5c2824..6f1bbf29 100644
--- a/src/server/api/history.py
+++ b/src/server/api/history.py
@@ -16,7 +16,8 @@
from server.const import USER_ROLES
from server.entities.history_detail import HistoryQuery
from server.entities.search_request import FilterOption, SearchResult
-from server.exc import DatabaseError, InvalidQueryError, RecordNotFound
+from server.exc import InvalidQueryError, RecordNotFound
+from server.messages import E
from server.services import history
from server.services.utils import search_history_filter_options
@@ -59,8 +60,8 @@ def filter_options_operators(
"""
try:
result = history.get_filter_items(tab, key="o", criteria=query)
- except InvalidQueryError as ex:
- return ErrorResponse(code="", message=str(ex)), 400
+ except InvalidQueryError as exc:
+ return ErrorResponse(message=exc.message), 400
return result, 200
@@ -81,15 +82,10 @@ def get(
SearchResult: if successful and status code 200
ErrorResponse: if a connection error occurs and status code 503
"""
- try:
- if tab == "download":
- result = history.get_download_history_data(query)
- else:
- result = history.get_upload_history_data(query)
- except DatabaseError:
- error = f"{tab} table connection error"
- current_app.logger.error(error)
- return ErrorResponse(code="", message=error), 503
+ if tab == "download":
+ result = history.get_download_history_data(query)
+ else:
+ result = history.get_upload_history_data(query)
return result, 200
@@ -115,8 +111,8 @@ def public_status(
result: bool = history.update_public_status(
tab=tab, history_id=history_id, public=body.public
)
- except RecordNotFound as ex:
- return ErrorResponse(code="", message=str(ex)), 404
+ except RecordNotFound as exc:
+ return ErrorResponse(message=exc.message), 404
return HistoryPublic(public=result), 200
@@ -136,12 +132,11 @@ def files(file_id: UUID) -> Response | tuple[ErrorResponse, int]:
try:
path_str = history.get_file_path(file_id)
file_path = Path(path_str)
- except RecordNotFound as ex:
- return ErrorResponse(code="", message=str(ex)), 404
+ except RecordNotFound as exc:
+ return ErrorResponse(message=exc.message), 404
if not file_path.exists():
- error = f"File not found: {file_id}"
- current_app.logger.error(error)
- return ErrorResponse(code="", message=error), 404
+ current_app.logger.error(E.FILE_NOT_FOUND, {"path": file_path})
+ return ErrorResponse(message=E.FILE_NOT_FOUND % {"path": file_path}), 404
return send_file(path_or_file=file_path)
@@ -160,8 +155,8 @@ def is_exist_files(file_id: UUID) -> tuple[bool | ErrorResponse, int]:
"""
try:
file_path = Path(history.get_file_path(file_id))
- except RecordNotFound as ex:
- return ErrorResponse(code="", message=str(ex)), 404
+ except RecordNotFound as exc:
+ return ErrorResponse(message=exc.message), 404
if not Path(file_path).exists():
return False, 200
return True, 200
diff --git a/src/server/api/schemas.py b/src/server/api/schemas.py
index c3e63630..0c81c541 100644
--- a/src/server/api/schemas.py
+++ b/src/server/api/schemas.py
@@ -354,3 +354,23 @@ class UploadQuery(BaseModel):
l: t.Annotated[int | None, "length"] = None # noqa: E741
"""Page size (number of items per page)."""
+
+
+class FileQuery(UsersQuery):
+ """Query parameters for file export."""
+
+ f: t.Annotated[t.Literal["tsv", "csv"], "format"] = "tsv"
+ """File format for export."""
+
+ model_config = ignore_extra_config
+ """Configure to ignore extra fields."""
+
+
+class ExportBody(BaseModel):
+ """Body for user export request."""
+
+ user_ids: list[str]
+ """List of user IDs to export."""
+
+ model_config = camel_case_config
+ """Configure to use camelCase aliasing."""
diff --git a/src/server/api/users.py b/src/server/api/users.py
index 17345031..1ccd4f37 100644
--- a/src/server/api/users.py
+++ b/src/server/api/users.py
@@ -9,7 +9,7 @@
import traceback
import typing as t
-from flask import Blueprint, current_app, url_for
+from flask import Blueprint, Response, current_app, send_file, url_for
from flask_login import current_user, login_required
from flask_pydantic import validate
@@ -18,6 +18,7 @@
from server.entities.search_request import FilterOption, SearchResult
from server.entities.user_detail import UserDetail
from server.exc import (
+ InvalidExportError,
InvalidFormError,
InvalidQueryError,
RequestConflict,
@@ -33,7 +34,7 @@
from .auth import logout
from .helpers import roles_required
-from .schemas import ErrorResponse, UsersQuery
+from .schemas import ErrorResponse, FileQuery, UsersQuery
bp = Blueprint("users", __name__)
@@ -203,3 +204,45 @@ def filter_options() -> list[FilterOption]:
list[FilterOption]: List of filter options for user search.
"""
return search_users_options()
+
+
+@bp.get("/export")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
+@validate(response_by_alias=True)
+def export_get(query: FileQuery) -> Response | tuple[ErrorResponse, int]:
+ """Export users to a file for bulk processing.
+
+ Args:
+ query (FileQuery): The query parameters for the export.
+
+ Returns:
+ Response: The response containing the exported file
+ ErrorResponse: The response containing an error message if the export fails
+ """
+ try:
+ files = users.make_export_file(current_user.map_id, current_user.name, query)
+ except InvalidExportError as exc:
+ return ErrorResponse(message=exc.message), 403
+ return send_file(files)
+
+
+@bp.post("/export")
+@login_required
+@roles_required(USER_ROLES.SYSTEM_ADMIN, USER_ROLES.REPOSITORY_ADMIN)
+@validate(response_by_alias=True)
+def export_post(query: FileQuery) -> Response | tuple[ErrorResponse, int]:
+ """Export users to a file for bulk processing.
+
+ Args:
+ query (FileQuery): The query parameters for the export.
+
+ Returns:
+ Response: The response containing the exported file
+ ErrorResponse: The response containing an error message if the export fails
+ """
+ try:
+ files = users.make_export_file(current_user.map_id, current_user.name, query)
+ except InvalidExportError as exc:
+ return ErrorResponse(message=exc.message), 403
+ return send_file(files)
diff --git a/src/server/cli/app.py b/src/server/cli/app.py
new file mode 100644
index 00000000..2af4be07
--- /dev/null
+++ b/src/server/cli/app.py
@@ -0,0 +1,26 @@
+#
+# Copyright (C) 2025 National Institute of Informatics.
+#
+
+"""Application command-line interface."""
+
+import pathlib
+import tomllib
+
+import click
+
+from flask import current_app
+
+
+@click.group()
+def app() -> None:
+ """Manage application."""
+
+
+@app.command()
+def version() -> None:
+ """Display application version."""
+ with pathlib.Path("pyproject.toml").open("rb") as f:
+ pyproject = tomllib.load(f)
+ version = pyproject["project"]["version"]
+ current_app.logger.info(version)
diff --git a/src/server/config.py b/src/server/config.py
index efcd5351..18ef59ec 100644
--- a/src/server/config.py
+++ b/src/server/config.py
@@ -83,6 +83,9 @@ class RuntimeConfig(BaseSettings):
GROUPS: GroupsConfig
"""Group related configuration values."""
+ USERS: UsersConfig
+ """Users related configuration values."""
+
POSTGRES: PostgresConfig = Field(
default_factory=lambda: PostgresConfig(), # noqa: PLW0108
exclude=True,
@@ -97,6 +100,12 @@ class RuntimeConfig(BaseSettings):
DEVELOP: DevelopConfig | None = None
+ FEATURES: FeaturesConfig
+ """Feature flags for enabling/disabling application features.
+
+ These are due to temporary constraints
+ in the future, all features will be enabled and the settings will be deleted."""
+
@computed_field
@property
def SQLALCHEMY_DATABASE_URI(self) -> URL:
@@ -408,6 +417,22 @@ def __getitem__(self, key: USER_ROLES) -> str: # noqa: D105
return getattr(self, key)
+class UsersConfig(BaseModel):
+ """Schema for user export file configuration."""
+
+ export_fields: list[str] = [
+ "id",
+ "user_name",
+ "groups[].id",
+ "groups[].name",
+ "role",
+ "edu_person_principal_names[]",
+ "preferred_language",
+ "emails[]",
+ ]
+ """List of fields to include in the exported user details."""
+
+
class MapCoreConfig(BaseModel):
"""Schema for mAP Core service configuration."""
@@ -575,6 +600,18 @@ class DevAccountConfig(BaseModel):
"""User name of the development account."""
+class FeaturesConfig(BaseModel):
+ """Schema for feature flags configuration."""
+
+ search_only_username: bool = True
+ """Whether user search by user name only in users.
+ If false, Enable search by username, email, or ePPN.
+ """
+
+ enable_bulk_operation: bool = False
+ """Whether mAP Core API bulk operation is enabled or disabled."""
+
+
def safe_eval(expr: str) -> int | str:
"""Safely evaluate a restricted arithmetic expression.
diff --git a/src/server/entities/bulk.py b/src/server/entities/bulk.py
index d7b034e2..d5a14932 100644
--- a/src/server/entities/bulk.py
+++ b/src/server/entities/bulk.py
@@ -35,23 +35,29 @@ class RepositoryMember(BaseModel):
"""The users belonging to the repository."""
-class ValidateSummary(BaseModel):
+class ValidateResults(BaseModel):
"""Model for summary of bulk validation result."""
- results: list[CheckResult]
+ results: list[EachResult]
"""The list of validation results for each user."""
- summary: HistorySummary
+ summary: ResultSummary
"""The summary of the validation operation."""
missing_user: list[UserDetail] = []
"""The list of missing users."""
+ offset: int
+ """The offset for pagination."""
+
+ page_size: int
+ """The page size for pagination."""
+
model_config = camel_case_config | forbid_extra_config
"""Configure camelCase aliasing and forbid extra fields."""
-class HistorySummary(BaseModel):
+class ResultSummary(BaseModel):
"""Summary of the history operation."""
create: int
@@ -69,7 +75,7 @@ class HistorySummary(BaseModel):
"""Configure camelCase aliasing and forbid extra fields."""
-class CheckResult(BaseModel):
+class EachResult(BaseModel):
"""Model for result of validation check for each user."""
id: str | None
@@ -97,13 +103,13 @@ class CheckResult(BaseModel):
"""Configure camelCase aliasing and forbid extra fields."""
-class ResultSummary(BaseModel):
+class ExecuteResults(BaseModel):
"""Model for summary of bulk upload result."""
- items: list[CheckResult]
+ items: list[EachResult]
"""The list of upload results for each user."""
- summary: HistorySummary
+ summary: ResultSummary
"""The summary of the upload operation."""
file_id: UUID
@@ -147,7 +153,7 @@ class Aggregated(t.TypedDict):
summary: dict[str, int]
"""Summary of the aggregation."""
- results: list[CheckResult]
+ results: list[EachResult]
"""List of check results."""
missing_user: list[UserDetail]
diff --git a/src/server/entities/history_detail.py b/src/server/entities/history_detail.py
index 9a4c5108..58312570 100644
--- a/src/server/entities/history_detail.py
+++ b/src/server/entities/history_detail.py
@@ -46,6 +46,9 @@ class DownloadHistoryData(BaseModel):
file_path: str
"""Path of the downloaded file."""
+ file_exists: bool = False
+ """Indicates if the downloaded file still exists."""
+
repository_count: int
"""Number of repositories involved in the download."""
diff --git a/src/server/exc.py b/src/server/exc.py
index 0be07137..ea1d7b8f 100644
--- a/src/server/exc.py
+++ b/src/server/exc.py
@@ -193,3 +193,31 @@ class FileValidationError(BulkOperationError):
Errors caused by validation failures during bulk operations.
"""
+
+
+class FileNotFound(BulkOperationError): # noqa: N818
+ """Exception for file not found errors in bulk operations.
+
+ Errors caused by missing files during bulk operations.
+ """
+
+
+class FileFormatError(BulkOperationError):
+ """Exception for file format errors in bulk operations.
+
+ Errors caused by invalid file formats during bulk operations.
+ """
+
+
+class FileUploadError(BulkOperationError):
+ """Exception for file upload errors in bulk operations.
+
+ Errors caused by issues during file upload in bulk operations.
+ """
+
+
+class InvalidExportError(BulkOperationError):
+ """Exception for invalid export errors.
+
+ Errors caused by issues during export operations.
+ """
diff --git a/src/server/messages/error.py b/src/server/messages/error.py
index 885c53ed..91e84a4b 100644
--- a/src/server/messages/error.py
+++ b/src/server/messages/error.py
@@ -554,6 +554,20 @@
"System Administrator.",
)
+USER_CANNOT_EXPORT_SYSTEM_ADMIN = LogMessage(
+ "E361",
+ "System Administrator user is not allowed to be exported.",
+)
+
+USER_FORBIDDEN_EXPORT = LogMessage(
+ "E362",
+ "Logged-in user does not have permission to export a User.",
+)
+
+FAILED_CREATE_DOWNLOAD_HISTORY_RECORD = LogMessage(
+ "E363",
+ "Failed to create download history for file (id: %(file_id)s) in database.",
+)
UNAUTHORIZED = LogMessage(
"E401",
@@ -576,6 +590,125 @@
"The server application is currently unavailable.",
)
+FAILED_BULK_OPERATION = LogMessage(
+ "E600",
+ "Failed to perform bulk operation.",
+)
+
+FAILED_SAVE_UPLOADED_FILE = LogMessage(
+ "E601",
+ "Failed to save uploaded file (path: %(file_path)s).",
+)
+
+OPERATION_FORBIDDEN = LogMessage(
+ "E602",
+ "Logged-in user does not have permission to perform this operation.",
+)
+
+FAILED_GET_UPLOAD_HISTORY_RECORD = LogMessage(
+ "E610",
+ "Failed to get upload history (id: %(history_id)s) from database.",
+)
+
+FAILED_GET_UPLOAD_HISTORY_RECORD_BY_FILE_ID = LogMessage(
+ "E611",
+ "Failed to get upload history by file ID (file_id: %(file_id)s) from database.",
+)
+
+FAILED_CREATE_UPLOAD_HISTORY_RECORD = LogMessage(
+ "E612",
+ "Failed to create upload history for file (id: %(file_id)s) in database.",
+)
+
+FAILED_UPDATE_HISTORY_RECORD_STATUS = LogMessage(
+ "E613",
+ "Failed to update upload history status (id: %(history_id)s) in database.",
+)
+
+INVALID_UPLOAD_HISTORY_RECORD_ATTRIBUTES = LogMessage(
+ "E614",
+ "Results must include 'summary' and 'results' keys",
+)
+
+UPDATE_HISTORY_RECORD_NOT_FOUND = LogMessage(
+ "E615",
+ "Record (id: %(id)s) not found in database.",
+)
+
+FAILED_GET_FILE_RECORD = LogMessage(
+ "E616",
+ "Failed to get file record(file_id: %(file_id)s) from database.",
+)
+
+FAILED_DELETE_FILE_RECORD = LogMessage(
+ "E617",
+ "Failed to delete file record(file_id: %(file_id)s) from database.",
+)
+
+INVALID_QUERY = LogMessage(
+ "E618",
+ "offset: %(offset)s and size: %(size)s must be non-negative integers.",
+)
+
+FAILED_CREATE_FILE_RECORD = LogMessage(
+ "E620",
+ "Failed to create file record for file (id: %(file_id)s) in database.",
+)
+
+INVALID_FILE_STRUCTURE = LogMessage(
+ "E621",
+ "Invalid file structure. Please check the file and try again.",
+)
+
+FILE_EXPIRED = LogMessage(
+ "E622", " File not found (path: %(path)s). It may have been expired."
+)
+
+FILE_FORMAT_UNSUPPORTED = LogMessage(
+ "E623",
+ "Unsupported file format (suffix: %(suffix)s).",
+)
+
+FILE_VALIDATION_ERROR = LogMessage(
+ "E624",
+ "File validation failed for task: %(task_id)s. Please check the file.",
+)
+
+TASK_NOT_FOUND = LogMessage(
+ "E634",
+ "Task (id: %(task_id)s) not found. It may have been expired.",
+)
+
+FAILED_GET_HISTORY_RECORDS = LogMessage(
+ "E700",
+ "Failed to get history records from table: %(table)s.",
+)
+
+FAILED_GET_HISTORY_RECORD = LogMessage(
+ "E701",
+ "Failed to get history record (id: %(history_id)s) from table: %(table)s.",
+)
+
+FAILED_UPDATE_PUBLIC = LogMessage(
+ "E702",
+ "Failed to update public status of history record (id: %(history_id)s) in"
+ " database.",
+)
+
+FILE_NOT_FOUND = LogMessage(
+ "E704",
+ "File not found (path: %(path)s).",
+)
+
+FAILED_GET_FILTER_ITEMS = LogMessage(
+ "E705",
+ "Failed to get filter items for history search (key: %(key)s).",
+)
+
+FAILED_GET_FILE_PATH = LogMessage(
+ "E706",
+ "Failed to get file path for file (id: %(file_id)s) from database.",
+)
UNNECESSARY_CONTRIB = LogMessage(
"E999", "Contrib utilities can only be used in development mode."
diff --git a/src/server/messages/info.py b/src/server/messages/info.py
index 8c5e825d..a65a805c 100644
--- a/src/server/messages/info.py
+++ b/src/server/messages/info.py
@@ -177,3 +177,35 @@
"I321",
"Successfully updated affiliations of User resource (id: %(id)s, ePPN: %(eppn)s).",
)
+
+
+SUCCESS_UPLOAD_FILES = LogMessage(
+ "I601",
+ "successfully uploaded file and create Files record: %(file_path)s",
+)
+
+SUCCESS_VALIDATE = LogMessage(
+ "I602",
+ "successfully validated the uploaded file: %(file_id)s",
+)
+
+SUCCESS_GET_VALIDATE_RESULT = LogMessage(
+ "I603",
+ "successfully retrieved validation result for history record: %(history_id)s",
+)
+
+SUCCESS_BULK_OPERATION = LogMessage(
+ "I604",
+ "successfully completed bulk operation for history record: %(history_id)s",
+)
+
+SUCCESS_GET_BULK_OPERATION_RESULT = LogMessage(
+ "I605",
+ "successfully retrieved bulk operation result for history record: %(history_id)s",
+)
+
+SUCCESS_UPDATE_PUBLIC_STATUS = LogMessage(
+ "I700",
+ "successfully update public status of history record (id: %(history_id)s) in"
+ " database.",
+)
diff --git a/src/server/services/bulks.py b/src/server/services/bulks.py
index 628ecddf..23e5f7d0 100644
--- a/src/server/services/bulks.py
+++ b/src/server/services/bulks.py
@@ -13,7 +13,7 @@
from http import HTTPStatus
from itertools import zip_longest
from pathlib import Path
-from uuid import UUID
+from uuid import UUID, uuid7
import openpyxl
import requests
@@ -21,17 +21,19 @@
from celery import shared_task
from flask import current_app
from pydantic import ValidationError
+from redis.exceptions import ConnectionError as RedisConnectionError
from server.clients import bulks
from server.config import config
-from server.const import ValidationEntity
+from server.const import USER_ROLES, ValidationEntity
+from server.db import db
from server.entities.bulk import (
- CheckResult,
- HistorySummary,
+ EachResult,
+ ExecuteResults,
RepositoryMember,
ResultSummary,
UserAggregated,
- ValidateSummary,
+ ValidateResults,
)
from server.entities.bulk_request import BulkOperation
from server.entities.map_error import MapError
@@ -39,21 +41,71 @@
from server.entities.map_user import EPPN, Email, Group, MapUser
from server.entities.patch_request import RemoveOperation
from server.entities.summaries import GroupSummary
-from server.entities.user_detail import UserDetail
+from server.entities.user_detail import RepositoryRole, UserDetail
from server.exc import (
+ DatastoreError,
+ FileFormatError,
+ FileNotFound,
+ FileUploadError,
FileValidationError,
+ InvalidFormError,
OAuthTokenError,
RecordNotFound,
- ResourceInvalid,
- ResourceNotFound,
+ TaskExcutionError,
UnexpectedResponseError,
)
+from server.messages import E, I
+from server.services.utils.permissions import (
+ get_permitted_repository_ids,
+ is_current_user_system_admin,
+)
+from server.services.utils.transformers import validate_user_to_map_user
from . import groups, history_table, users, utils
from .token import get_access_token, get_client_secret
from .utils import session_required
+if t.TYPE_CHECKING:
+ from celery.result import AsyncResult
+ from werkzeug.datastructures import FileStorage
+
+
+def upload_file(repository_id: str, bulk_file: FileStorage) -> UUID:
+ """Upload a file for bulk processing.
+
+ Args:
+ repository_id (str): Target repository ID for upload.
+ bulk_file (FileStorage): File to upload.
+
+ Returns:
+ UUID: The ID of the temporary file.
+
+ Raises:
+ FileUploadError: If there is an error saving the uploaded file.
+ """
+ temp_id = uuid7()
+ temp_dir = Path(config.STORAGE.local.temporary)
+ original_filename = bulk_file.filename or "upload_file"
+ new_filename = f"{temp_id}_{Path(original_filename).name}"
+ file_path = temp_dir / new_filename
+ file_content = {"repositories": [{"id": repository_id}]}
+ history_table.create_file(
+ file_id=temp_id, file_path=str(file_path), file_content=file_content
+ )
+ try:
+ bulk_file.save(str(file_path))
+ except (PermissionError, FileNotFoundError) as exc:
+ db.session.rollback()
+ raise FileUploadError(
+ E.FAILED_SAVE_UPLOADED_FILE % {"file_path": file_path}
+ ) from exc
+ db.session.commit()
+ current_app.logger.info(I.SUCCESS_UPLOAD_FILES, {"file_path": file_path})
+ delete_temporary_file.apply_async((str(temp_id),), countdown=3600)
+ return temp_id
+
+
@shared_task()
@session_required
def validate_upload_data(
@@ -76,8 +128,12 @@ def validate_upload_data(
data, new_data = build_user_from_file(file_path)
- updata_users: list[UserDetail] = build_user_detail_from_dict(data).root
- create_users: list[UserDetail] = build_user_detail_from_dict_by_name(new_data).root
+ updata_users: list[UserDetail] = build_user_detail_from_dict(
+ data, repository_id
+ ).root
+ create_users: list[UserDetail] = build_user_detail_from_dict_by_name(
+ new_data, repository_id
+ ).root
updata_users_id = {u.id for u in updata_users if u.id is not None}
missing_users = _get_missing_users(repository_member, updata_users_id)
repo_user_by_id = _get_repo_user_by_id(repository_member, updata_users_id)
@@ -86,15 +142,21 @@ def validate_upload_data(
updata_users, create_users, repository_member, repo_user_by_id
)
- results = ValidateSummary(
- results=check_results, summary=summary, missing_user=missing_users
+ results = ValidateResults(
+ results=check_results,
+ summary=summary,
+ missing_user=missing_users,
+ offset=0,
+ page_size=len(check_results),
)
- return history_table.create_upload(
+ result = history_table.create_upload(
operator_id=operator_id,
operator_name=operator_name,
file_id=temp_file_id,
results=results.model_dump(mode="json"),
)
+ current_app.logger.info(I.SUCCESS_VALIDATE, {"file_id": temp_file_id})
+ return result.id
def get_repository_member(repository_id: str) -> RepositoryMember:
@@ -130,44 +192,46 @@ def build_user_from_file(
A tuple containing two dictionaries:
- The first dictionary contains user data keyed by user ID.
- The second dictionary contains new user data keyed by user name.
-
- Raises:
- ResourceNotFound: If the file does not exist.
"""
- try:
- gen = _read_file(file_path)
- except (ResourceInvalid, ResourceNotFound) as e:
- current_app.logger.error(e)
- raise ResourceNotFound(str(e)) from e
+ gen = _read_file(file_path)
it = next(gen)
- header = [("" if h is None else str(h).strip()) for h in next(it)]
- _ = next(it)
- id_idx = header.index("id")
- idx_of = {name: i for i, name in enumerate(header)}
data = defaultdict(lambda: defaultdict(list))
new_data = defaultdict(lambda: defaultdict(list))
- for row in it:
- if row is None:
+
+ idx_of = {}
+ id_idx = None
+ user_name_idx = None
+ header_row_index = 1
+
+ for i, row in enumerate(it):
+ if i == header_row_index + 1 or row is None:
continue
- r = list(row)
- rid = r[id_idx]
- if not rid:
+ if i == 0:
+ _ = (str(h).strip() if h is not None else "" for h in row)
+
+ if i == header_row_index:
+ header = [str(h).strip() if h is not None else "" for h in row]
+ idx_of = {name: idx for idx, name in enumerate(header)}
+ id_idx = idx_of.get("id")
user_name_idx = idx_of.get("user_name")
- if user_name_idx is None:
- continue
- user_name_value = r[user_name_idx]
- bucket = new_data[user_name_value]
- for col, j in idx_of.items():
- if col != "user_name":
- bucket[col].append(r[j])
continue
- bucket = data[rid]
+ r = list(row)
+ rid = r[id_idx] if id_idx is not None else None
+
+ if rid:
+ bucket = data[rid]
+ exclude = {"id"}
+ else:
+ user_name_value = r[user_name_idx] if user_name_idx else None
+ bucket = new_data[user_name_value]
+ exclude = {"user_name"}
for col, j in idx_of.items():
- if col != "id":
+ if col not in exclude:
bucket[col].append(r[j])
+
return dict(data), dict(new_data)
@@ -177,15 +241,14 @@ def _read_file(file_path: str) -> t.Generator:
Args:
file_path (str): Path to the input file containing user data.
-
Raises:
- ResourceNotFound: If the file does not exist.
- ResourceInvalid : If the format is unsupported or parsing fails.
+ FileNotFound: If the file does not exist.
+ FileFormatError : If the format is unsupported or parsing fails.
+ FileValidationError: If the file content is invalid.
"""
path = Path(file_path)
if not path.exists():
- error = f"{path}: File not found."
- raise ResourceNotFound(error)
+ raise FileNotFound(E.FILE_EXPIRED % {"path": path})
iterator = None
suffix = path.suffix.lower()
@@ -199,15 +262,18 @@ def _read_file(file_path: str) -> t.Generator:
ws = wb.active
if ws:
iterator = ws.iter_rows(values_only=True)
+ else:
+ error = f"{path}: No active sheet found in the Excel file."
+ current_app.logger.error(error)
+ raise FileValidationError(E.INVALID_FILE_STRUCTURE)
if iterator is None:
- error = f"{path.suffix}: Unsupported file format."
- raise ResourceInvalid(error)
+ raise FileFormatError(E.FILE_FORMAT_UNSUPPORTED % {"suffix": path.suffix})
yield iterator
def build_user_detail_from_dict(
- data: dict[str, dict[str, list[str]]],
+ data: dict[str, dict[str, list[str]]], repository_id: str
) -> UserAggregated:
"""Build UserAggregated from a dictionary of user data.
@@ -215,10 +281,14 @@ def build_user_detail_from_dict(
data (dict[str, dict[str, list[str]]]):
A dictionary where the key is the user ID and the value is another
dictionary containing user attributes.
+ repository_id (str): The ID of the repository to which the users belong.
Returns:
UserAggregated:
The aggregated user details built from the input dictionary.
+
+ Raises:
+ FileValidationError: If there is an error validating the user data.
"""
users: list[UserDetail] = []
@@ -237,9 +307,14 @@ def build_user_detail_from_dict(
if preferred_language_list is not None and len(preferred_language_list) > 0
else ""
)
+ str_role = columns.get("role")
+ role = str_role[0] if str_role and len(str_role) > 0 else None
+ repository_roles: list[RepositoryRole] = [
+ RepositoryRole(id=repository_id, user_role=_resolve_non_sysadmin_role(role))
+ ]
- eppns: set[str] = set(columns.get("edu_person_principal_names[]") or [])
- emails: set[str] = set(columns.get("emails[]") or [])
+ eppns: list[str] = list(set(columns.get("edu_person_principal_names[]") or []))
+ emails: list[str] = list(set(columns.get("emails[]") or []))
gid_list: list[str] = list(columns.get("groups[].id") or [])
gname_list: list[str] = list(columns.get("groups[].name") or [])
@@ -263,15 +338,19 @@ def build_user_detail_from_dict(
user_name=user_name,
emails=emails,
preferred_language=preferred_language,
+ repository_roles=repository_roles,
groups=groups,
)
)
-
- return UserAggregated(root=users)
+ try:
+ return UserAggregated(root=users)
+ except ValidationError as exc:
+ current_app.logger.error(exc)
+ raise FileValidationError(E.INVALID_FILE_STRUCTURE) from exc
def build_user_detail_from_dict_by_name(
- data: dict[str, dict[str, list[str]]],
+ data: dict[str, dict[str, list[str]]], repository_id: str
) -> UserAggregated:
"""Build UserAggregated from a dictionary of user data.
@@ -279,10 +358,14 @@ def build_user_detail_from_dict_by_name(
data (dict[str, dict[str, list[str]]]):
A dictionary where the key is the user name and the value is another
dictionary containing user attributes.
+ repository_id (str): The ID of the repository to which the users belong.
Returns:
UserAggregated:
The aggregated user details built from the input dictionary.
+
+ Raises:
+ FileValidationError: If there is an error validating the user data.
"""
users: list[UserDetail] = []
@@ -298,11 +381,16 @@ def build_user_detail_from_dict_by_name(
else ""
)
- eppns: set[str] = set(columns.get("edu_person_principal_names[]") or [])
- emails: set[str] = set(columns.get("emails[]") or [])
+ eppns: list[str] = list(set(columns.get("edu_person_principal_names[]") or []))
+ emails: list[str] = list(set(columns.get("emails[]") or []))
gid_list: list[str] = list(columns.get("groups[].id") or [])
gname_list: list[str] = list(columns.get("groups[].name") or [])
+ str_role = columns.get("role")
+ role = str_role[0] if str_role and len(str_role) > 0 else None
+ repository_roles: list[RepositoryRole] = [
+ RepositoryRole(id=repository_id, user_role=_resolve_non_sysadmin_role(role))
+ ]
groups: list[GroupSummary] = []
seen = set()
for gid, gname in zip_longest(gid_list, gname_list, fillvalue=None):
@@ -323,11 +411,22 @@ def build_user_detail_from_dict_by_name(
user_name=user_name,
emails=emails,
preferred_language=preferred_language,
+ repository_roles=repository_roles,
groups=groups,
)
)
+ try:
+ return UserAggregated(root=users)
+ except ValidationError as exc:
+ current_app.logger.error(exc)
+ raise FileValidationError(E.INVALID_FILE_STRUCTURE) from exc
+
+
+_ROLE_MAP = {m.value: m for m in USER_ROLES if m is not USER_ROLES.SYSTEM_ADMIN}
- return UserAggregated(root=users)
+
+def _resolve_non_sysadmin_role(role: str | None) -> USER_ROLES | None:
+ return _ROLE_MAP.get(role) if role else None
def _get_missing_users(
@@ -363,13 +462,13 @@ def _build_check_results(
create_users: list[UserDetail],
repository_member: RepositoryMember,
repo_user_by_id: dict[str, UserDetail],
-) -> tuple[list[CheckResult], HistorySummary]:
+) -> tuple[list[EachResult], ResultSummary]:
count_create = 0
count_update = 0
count_delete = 0
count_skip = 0
count_error = 0
- check_results: list[CheckResult] = []
+ check_results: list[EachResult] = []
for u in create_users:
code = None
user_group_ids = {g.id for g in u.groups} if u.groups else set()
@@ -377,7 +476,7 @@ def _build_check_results(
if not user_group_ids.issubset(repository_member.groups):
code = "Group ID does not exist"
check_results.append(
- CheckResult(
+ EachResult(
id=u.id,
eppn=u.eppns or [],
user_name=u.user_name,
@@ -389,25 +488,25 @@ def _build_check_results(
)
count_error += 1
continue
-
- if not _check_value(u):
- code = "Invalid user data"
+ try:
+ validate_user_to_map_user(u, mode="create")
+ except InvalidFormError as exc:
check_results.append(
- CheckResult(
+ EachResult(
id=u.id,
eppn=u.eppns or [],
user_name=u.user_name,
groups=user_group_ids,
email=u.emails or [],
status="error",
- code=code,
+ code=exc.message,
)
)
count_error += 1
continue
check_results.append(
- CheckResult(
+ EachResult(
id=u.id,
eppn=u.eppns or [],
user_name=u.user_name,
@@ -436,7 +535,7 @@ def _build_check_results(
count_skip += 1
code = _check_immutable_attributes(repo_user, u)
check_results.append(
- CheckResult(
+ EachResult(
id=u.id,
eppn=repo_user.eppns or [],
user_name=repo_user.user_name,
@@ -446,7 +545,7 @@ def _build_check_results(
code=code,
)
)
- summary = HistorySummary(
+ summary = ResultSummary(
create=count_create,
update=count_update,
delete=count_delete,
@@ -467,7 +566,7 @@ def _check_value(user: UserDetail) -> bool:
"""
if not user.id:
return False
- if not re.compile(r"^[A-Za-z0-9]{1,50}$").fullmatch(user.id):
+ if not re.compile(r"^[A-Za-z0-9._-]{1,50}$").fullmatch(user.id):
return False
return len(user.user_name) <= ValidationEntity.USER_NAME_MAX_LENGTH
@@ -484,22 +583,44 @@ def _check_immutable_attributes(
Returns:
str | None: The name of the immutable attribute if found, None otherwise.
"""
+ if original.user_name != update_user.user_name:
+ return "user_name is immutable"
if original.emails != update_user.emails:
- return "emails"
+ return "emails are immutable"
if original.eppns != update_user.eppns:
- return "eppns"
+ return "eppns are immutable"
if original.preferred_language != update_user.preferred_language:
- return "preferred_language"
- if original.last_modified != update_user.last_modified:
- return "last_modified"
- if original.created != update_user.created:
- return "created"
+ return "preferred_language is immutable"
return None
+def get_validate_task_result(task_id: str) -> AsyncResult[UUID]:
+ """Get the result of a validation task.
+
+ Args:
+ task_id (str): The ID of the validation task.
+
+ Returns:
+ AsyncResult[UUID]: The result of the validation task.
+
+ Raises:
+ DatastoreError: If there is an error connecting to the datastore.
+ TaskExcutionError: If the task with the given ID does not exist.
+ """
+ try:
+ res = validate_upload_data.AsyncResult(task_id)
+ except RedisConnectionError as exc:
+ current_app.logger.error(E.FAILED_CONNECT_REDIS, {"error": str(exc)})
+ raise DatastoreError(E.FAILED_CONNECT_REDIS % {"error": str(exc)}) from exc
+ if not res:
+ current_app.logger.error(E.TASK_NOT_FOUND, {"task_id": task_id})
+ raise TaskExcutionError(E.TASK_NOT_FOUND % {"task_id": task_id})
+ return res
+
+
def get_validate_result(
history_id: UUID, status_filter: list[str], offset: int, size: int
-) -> ValidateSummary:
+) -> ValidateResults:
"""Get the validation result summary for the specified upload history ID.
Args:
@@ -514,51 +635,53 @@ def get_validate_result(
results = history_table.get_paginated_upload_results(
history_id, offset, size, status_filter
)
- check_results = [CheckResult.model_validate(it) for it in results]
+ check_results = [EachResult.model_validate(it) for it in results]
summary = history_table.get_upload_results(history_id, "summary")
missing_user = history_table.get_upload_results(history_id, "missingUser")
- return ValidateSummary.model_validate({
+ result = ValidateResults.model_validate({
"results": check_results,
"summary": summary,
"missingUser": missing_user or [],
"offset": offset,
"pageSize": size,
})
+ current_app.logger.info(I.SUCCESS_GET_VALIDATE_RESULT, {"history_id": history_id})
+ return result
@shared_task()
def update_users(
- history_id: UUID, temp_file_id: UUID, delete_users: list[str] | None
+ history_id: UUID, temp_file_id: UUID, remove_users: list[str] | None
) -> UUID:
"""Perform bulk update of users based on the validation results.
Args:
history_id (UUID): The ID of the upload history.
temp_file_id (UUID): The ID of the temporary file.
- delete_users (list[str] | None): The list of user IDs to be deleted.
+ remove_users (list[str] | None):
+ The list of user IDs to be removed by repository.
Returns:
UUID: The ID of the upload history record.
Raises:
- ResourceNotFound: If the upload history does not exist.
+ FileNotFound: If the upload history does not exist.
requests.RequestException: If there is an error communicating with mAP Core API.
ValidationError: If there is an error parsing the response from mAP Core API.
OAuthTokenError: If there is an issue with the access token.
UnexpectedResponseError: If there is an unexpected response from mAP Core API.
- ResourceInvalid: If there is an invalid resource error from mAP Core API.
FileValidationError: If there are errors in the validation results.
"""
upload_data = history_table.get_upload_by_id(history_id)
if not upload_data:
error = f"History not found: {history_id}"
current_app.logger.error(error)
- raise ResourceNotFound(error)
+ raise FileNotFound(error)
# file content must contain at least one repository.
repository_id = upload_data.file.file_content["repositories"][0]["id"]
- check_results: list[CheckResult] = upload_data.results.get("results", [])
+ check_results: list[EachResult] = upload_data.results.get("results", [])
summary = upload_data.results.get("summary", {})
if summary.get("error", 1) > 0:
@@ -567,7 +690,7 @@ def update_users(
raise FileValidationError(error)
bulk_ops, count_delete = _build_bulk_operations_from_check_results(
- repository_id, check_results, delete_users
+ repository_id, check_results, remove_users
)
summary.update({"delete": count_delete})
@@ -597,8 +720,8 @@ def update_users(
raise
if isinstance(result, MapError):
- current_app.logger.info(result.detail)
- raise ResourceInvalid(result.detail)
+ current_app.logger.error(E.RECEIVE_RESPONSE_MESSAGE, {"message": result.detail})
+ raise UnexpectedResponseError(result.detail)
count_error = 0
for i, operation in enumerate(result.operations):
@@ -623,6 +746,7 @@ def update_users(
status="S",
)
+ current_app.logger.info(I.SUCCESS_BULK_OPERATION, {"history_id": history_id})
return history_id
@@ -636,25 +760,24 @@ def save_file(temp_file_id: UUID) -> UUID:
UUID: The ID of the saved permanent file.
Raises:
- ResourceNotFound: If the temporary file does not exist.
- ResourceInvalid: If the file format is invalid.
+ FileNotFound: If the temporary file does not exist.
+ FileFormatError: If the file format is invalid.
"""
try:
files = history_table.get_file_by_id(temp_file_id)
repository_id = files.file_content["repositories"][0]["id"]
except (KeyError, AttributeError) as e:
current_app.logger.error("Failed to retrieve temporary file: %s", temp_file_id)
- raise ResourceNotFound(str(e)) from e
+ raise FileNotFound(str(e)) from e
file_path = Path(files.file_path)
if file_path.parent != Path(config.STORAGE.local.temporary):
return files.id
if not file_path.exists():
error_msg = f"File not found: {file_path}"
- raise ResourceNotFound(error_msg)
+ raise FileNotFound(error_msg)
if file_path.suffix not in {".csv", ".tsv", ".xlsx"}:
- error = "not supported file format."
- raise ResourceInvalid(error)
+ raise FileFormatError(E.FILE_FORMAT_UNSUPPORTED % {"suffix": file_path.suffix})
target_dir = Path(config.STORAGE.local.storage) / datetime.now(UTC).strftime(
"%Y/%m"
@@ -665,10 +788,10 @@ def save_file(temp_file_id: UUID) -> UUID:
return history_table.create_file(
file_path=str(target_path),
file_content={"repositories": [{"id": repository_id}]},
- )
+ ).id
-def build_map_user_from_check_result(user: CheckResult) -> MapUser:
+def build_map_user_from_check_result(user: EachResult) -> MapUser:
"""Build MapUser from CheckResult.
Args:
@@ -718,7 +841,7 @@ def build_remove_user_path(user: UserDetail, repository_id: str) -> BulkOperatio
def _build_bulk_operations_from_check_results(
- repository_id: str, check_results: list[CheckResult], delete_users: list[str] | None
+ repository_id: str, check_results: list[EachResult], remove_users: list[str] | None
) -> tuple[list[BulkOperation], int]:
repository_member = get_repository_member(repository_id)
@@ -761,7 +884,7 @@ def _build_bulk_operations_from_check_results(
])
delete_user_list = users.search(
- utils.make_criteria_object("users", i=delete_users), raw=True
+ utils.make_criteria_object("users", i=remove_users), raw=True
).resources
group_user_ops = {}
@@ -776,7 +899,7 @@ def _build_bulk_operations_from_check_results(
"remove"
].add(user.id)
check_results.append(
- CheckResult(
+ EachResult(
id=user.id,
eppn=user.eppns or [],
user_name=user.user_name,
@@ -822,9 +945,33 @@ def _build_groups_update_bulk_operations(
return bulk_ops
+def get_execute_task_result(task_id: str) -> AsyncResult[UUID]:
+ """Get the result of an execution task.
+
+ Args:
+ task_id (str): The ID of the execution task.
+
+ Returns:
+ AsyncResult[UUID]: The result of the execution task.
+
+ Raises:
+ DatastoreError: If there is an error connecting to the datastore.
+ TaskExcutionError: If the task with the given ID does not exist.
+ """
+ try:
+ res = update_users.AsyncResult(task_id)
+ except RedisConnectionError as exc:
+ current_app.logger.error(E.FAILED_CONNECT_REDIS, {"error": str(exc)})
+ raise DatastoreError(E.FAILED_CONNECT_REDIS % {"error": str(exc)}) from exc
+ if not res:
+ current_app.logger.error(E.TASK_NOT_FOUND, {"task_id": task_id})
+ raise TaskExcutionError(E.TASK_NOT_FOUND % {"task_id": task_id})
+ return res
+
+
def get_upload_result(
history_id: UUID, status_filter: list[str], offset: int, size: int
-) -> ResultSummary:
+) -> ExecuteResults:
"""Get the bulk operation result summary with filtering and pagination.
Args:
@@ -834,15 +981,14 @@ def get_upload_result(
offset (int): The offset for pagination.
Returns:
- ResultSummary: The summary of the bulk operation result.
+ ExecuteResults: The summary of the bulk operation result.
Raises:
RecordNotFound: If the upload history with the given ID does not exist.
"""
upload = history_table.get_upload_by_id(history_id)
if not upload:
- error = f"upload history not found: {history_id}"
- raise RecordNotFound(error)
+ raise RecordNotFound(E.UPDATE_HISTORY_RECORD_NOT_FOUND % {"id": history_id})
raw_results: list[dict] = history_table.get_paginated_upload_results(
history_id, offset, size, status_filter or []
@@ -851,17 +997,22 @@ def get_upload_result(
summary = history_table.get_upload_results(history_id, "summary")
payload = {
- "results": raw_results,
+ "items": raw_results,
"summary": summary,
"fileId": upload.file_id,
"fileName": Path(upload.file.file_path).name,
"operator": upload.operator_name or upload.operator_id,
"startTimestamp": upload.timestamp,
"endTimestamp": upload.end_timestamp,
+ "total": 0,
"offset": offset,
"pageSize": size,
}
- return ResultSummary.model_validate(payload)
+ result = ExecuteResults.model_validate(payload)
+ current_app.logger.info(
+ I.SUCCESS_GET_BULK_OPERATION_RESULT, {"history_id": history_id}
+ )
+ return result
@shared_task()
@@ -879,3 +1030,45 @@ def delete_temporary_file(temp_id: str) -> None:
if Path(file_path).exists():
Path(file_path).unlink()
history_table.delete_file_by_id(temp_file_id)
+
+
+def chack_permission_to_operation(history_id: UUID, operator_id: str) -> bool:
+ """Check if the user has permission to perform bulk operation.
+
+ Args:
+ history_id (UUID): The ID of the upload history.
+ operator_id (str): The ID of the operator.
+
+ Returns:
+ bool: True if the user has permission, False otherwise.
+
+ Raises:
+ RecordNotFound: If the upload history with the given ID does not exist.
+ """
+ upload = history_table.get_upload_by_id(history_id)
+ if not upload:
+ current_app.logger.error(E.UPDATE_HISTORY_RECORD_NOT_FOUND, {"id": history_id})
+ raise RecordNotFound(E.UPDATE_HISTORY_RECORD_NOT_FOUND % {"id": history_id})
+ return upload.operator_id == operator_id
+
+
+def chack_permission_to_view(history_id: UUID) -> bool:
+ """Check if the user has permission to view the specified upload history.
+
+ Args:
+ history_id (UUID): The ID of the upload history.
+
+ Returns:
+ bool: True if the user has permission, False otherwise.
+
+ Raises:
+ RecordNotFound: If the upload history with the given ID does not exist.
+ """
+ if is_current_user_system_admin():
+ return True
+ upload = history_table.get_upload_by_id(history_id)
+ if not upload:
+ current_app.logger.error(E.UPDATE_HISTORY_RECORD_NOT_FOUND, {"id": history_id})
+ raise RecordNotFound(E.UPDATE_HISTORY_RECORD_NOT_FOUND % {"id": history_id})
+ repository_id = upload.file.file_content["repositories"][0]["id"]
+ return repository_id not in get_permitted_repository_ids() and upload.public
diff --git a/src/server/services/groups.py b/src/server/services/groups.py
index 8365cc07..e1c49b0c 100644
--- a/src/server/services/groups.py
+++ b/src/server/services/groups.py
@@ -472,6 +472,8 @@ def delete_multiple(group_ids: set[str]) -> set[str] | None:
CredentialsError: If the client credentials are invalid.
UnexpectedResponseError: If response from mAP Core API is unexpected.
"""
+ if config.FEATURES.enable_bulk_operation:
+ return delete_multiple_sequentially(group_ids)
operations = [
BulkOperation(method="DELETE", path=f"/Groups/{group_id}")
for group_id in group_ids
@@ -525,6 +527,35 @@ def delete_multiple(group_ids: set[str]) -> set[str] | None:
return failed_list if failed_list != set() else None
+def delete_multiple_sequentially(group_ids: set[str]) -> set[str] | None:
+ """Delete groups from mAP Core API by group_ids asynchronously.
+
+ Args:
+ group_ids (list[str]): ID of the Group resource.
+
+ Returns:
+ list[str]: group id list of failed.
+
+ Raises:
+ OAuthTokenError: If the access token is invalid or expired.
+ CredentialsError: If the client credentials are invalid.
+ """
+ failed_list: set[str] = set()
+ for group_id in group_ids:
+ try:
+ delete_by_id(group_id)
+ except OAuthTokenError, CredentialsError:
+ raise
+ except (
+ ResourceNotFound,
+ ResourceInvalid,
+ UnexpectedResponseError,
+ ):
+ failed_list.add(group_id)
+
+ return failed_list if failed_list != set() else None
+
+
def delete_by_id(group_id: str) -> None:
"""Delete group from mAP Core API by group_id.
diff --git a/src/server/services/history.py b/src/server/services/history.py
index bc3789e6..7e9e6a04 100644
--- a/src/server/services/history.py
+++ b/src/server/services/history.py
@@ -6,7 +6,8 @@
import typing as t
-from datetime import date, datetime, time, timedelta
+from datetime import date, timedelta
+from pathlib import Path
from types import SimpleNamespace
from uuid import UUID
@@ -14,6 +15,7 @@
from sqlalchemy import cast, func, or_, select
from sqlalchemy.dialects.postgresql import JSONB
from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.orm import aliased
from server.const import DEFAULT_SEARCH_COUNT
from server.db.history import DownloadHistory, Files, UploadHistory
@@ -25,6 +27,7 @@
from server.entities.search_request import SearchResult
from server.entities.summaries import UserSummary
from server.exc import DatabaseError, InvalidQueryError, RecordNotFound
+from server.messages import E, I
from .utils import (
get_permitted_repository_ids,
@@ -49,25 +52,30 @@ def get_upload_history_data(
Returns:
SearchResult: upload history data with pagination.
+ Raises:
+ DatabaseError: If a database operation fails.
"""
filters = _build_filters_for_history(criteria, history_type="upload")
base_stmt = select(UploadHistory, Files).join(UploadHistory.file).filter(*filters)
count_stmt = select(func.count()).select_from(base_stmt.subquery())
+ try:
+ total = db.session.execute(count_stmt).scalar_one()
- total = db.session.execute(count_stmt).scalar_one()
-
- if criteria.d == "desc":
- stmt = base_stmt.order_by(UploadHistory.timestamp.desc())
- else:
- stmt = base_stmt.order_by(UploadHistory.timestamp.asc())
+ if criteria.d == "desc":
+ stmt = base_stmt.order_by(UploadHistory.timestamp.desc())
+ else:
+ stmt = base_stmt.order_by(UploadHistory.timestamp.asc())
- page = criteria.p or 1
- page_size = criteria.l or DEFAULT_SEARCH_COUNT
- offset = (page - 1) * page_size
- stmt = stmt.limit(page_size).offset(offset)
+ page = criteria.p or 1
+ page_size = criteria.l or DEFAULT_SEARCH_COUNT
+ offset = (page - 1) * page_size
+ stmt = stmt.limit(page_size).offset(offset)
- rows = db.session.execute(stmt).all()
+ rows = db.session.execute(stmt).all()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(E.FAILED_GET_HISTORY_RECORDS % {"table": "upload"}) from exc
data = [
{
**history.__dict__,
@@ -138,7 +146,7 @@ def _build_filters_for_history(
if criteria.s and criteria.e:
start = criteria.s
- end = datetime.combine(criteria.e, time.max)
+ end = criteria.e + timedelta(days=1)
filters.extend((
history_model.timestamp >= start,
history_model.timestamp < end,
@@ -151,7 +159,8 @@ def _build_filters_for_history(
history_model.timestamp < end,
))
elif criteria.e and not criteria.s:
- filters.append(history_model.timestamp <= criteria.e)
+ end = criteria.e + timedelta(days=1)
+ filters.append(history_model.timestamp < end)
if history_type == "download":
if not criteria.i:
@@ -174,6 +183,8 @@ def get_download_history_data(
Returns:
SearchResult: download history data with pagination.
+ Raises:
+ DatabaseError: If a database operation fails.
"""
filters = _build_filters_for_history(criteria, history_type="download")
@@ -181,26 +192,34 @@ def get_download_history_data(
select(DownloadHistory, Files).join(DownloadHistory.file).filter(*filters)
)
count_stmt = select(func.count()).select_from(base_stmt.subquery())
- total = db.session.execute(count_stmt).scalar_one()
-
- subq = (
- select(func.count(DownloadHistory.id))
- .where(DownloadHistory.parent_id == DownloadHistory.id)
- .scalar_subquery()
- )
- stmt = base_stmt.add_columns(subq)
+ try:
+ total = db.session.execute(count_stmt).scalar_one()
+
+ child = aliased(DownloadHistory)
+ subq = (
+ select(func.count(child.id))
+ .where(child.parent_id == DownloadHistory.id)
+ .correlate(DownloadHistory)
+ .scalar_subquery()
+ )
+ stmt = base_stmt.add_columns(subq)
- if criteria.d == "desc":
- stmt = stmt.order_by(DownloadHistory.timestamp.desc())
- else:
- stmt = stmt.order_by(DownloadHistory.timestamp.asc())
+ if criteria.d == "desc":
+ stmt = stmt.order_by(DownloadHistory.timestamp.desc())
+ else:
+ stmt = stmt.order_by(DownloadHistory.timestamp.asc())
- page = criteria.p or 1
- page_size = criteria.l or DEFAULT_SEARCH_COUNT
- offset = (page - 1) * page_size
- stmt = stmt.limit(page_size).offset(offset)
+ page = criteria.p or 1
+ page_size = criteria.l or DEFAULT_SEARCH_COUNT
+ offset = (page - 1) * page_size
+ stmt = stmt.limit(page_size).offset(offset)
- rows = db.session.execute(stmt).all()
+ rows = db.session.execute(stmt).all()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_GET_HISTORY_RECORDS % {"table": "download"}
+ ) from exc
data = [
{
**history.__dict__,
@@ -211,6 +230,7 @@ def get_download_history_data(
"group_count": len(file.file_content.get("groups", [])),
"user_count": len(file.file_content.get("users", [])),
"children_count": children_count,
+ "file_exists": Path(file.file_path).exists(),
}
for history, file, children_count in t.cast(
"t.Sequence[tuple[DownloadHistory, Files, int]]", rows
@@ -219,7 +239,7 @@ def get_download_history_data(
return SearchResult[DownloadHistoryData].model_validate(
{
"total": total,
- "pageSize": page_size,
+ "page_size": page_size,
"offset": offset,
"resources": data,
},
@@ -242,6 +262,7 @@ def get_filter_items(
Raises:
InvalidQueryError: If the filter key is invalid.
+ DatabaseError: If a database operation fails.
"""
table = UploadHistory if tab == "upload" else DownloadHistory
if key == "o":
@@ -250,8 +271,11 @@ def get_filter_items(
page_size = criteria.l or DEFAULT_SEARCH_COUNT
offset = (page - 1) * page_size
stmt = stmt.limit(page_size).offset(offset)
-
- results = db.session.execute(stmt).all()
+ try:
+ results = db.session.execute(stmt).all()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(E.FAILED_GET_HISTORY_RECORDS % {"table": tab}) from exc
items = [
UserSummary(id=operator_id, user_name=operator_name)
for operator_id, operator_name in results
@@ -260,9 +284,8 @@ def get_filter_items(
resources=items, total=0, page_size=page_size, offset=offset
)
- error = f"Unsupported criteria type: {type(criteria)}"
- current_app.logger.error(error)
- raise InvalidQueryError(error)
+ current_app.logger.error(E.FAILED_GET_FILTER_ITEMS, {"key": key})
+ raise InvalidQueryError(E.FAILED_GET_FILTER_ITEMS % {"key": key})
def update_public_status(
@@ -287,14 +310,18 @@ def update_public_status(
record = db.session.get(table, history_id)
if record is None:
- error = f"{history_id} is not found"
- raise RecordNotFound(error)
+ raise RecordNotFound(
+ E.FAILED_GET_HISTORY_RECORD % {"history_id": history_id, "table": tab}
+ )
record.public = public
except SQLAlchemyError as exc:
- error = "Failed to update the public status due to a database error."
- raise DatabaseError(error) from exc
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_UPDATE_PUBLIC % {"history_id": history_id}
+ ) from exc
db.session.commit()
+ current_app.logger.info(I.SUCCESS_UPDATE_PUBLIC_STATUS)
return record.public
@@ -314,12 +341,11 @@ def get_file_path(file_id: UUID) -> str:
try:
file = db.session.get(Files, file_id)
except SQLAlchemyError as exc:
- error = "Failed to retrieve the file path due to a database error."
- raise DatabaseError(error) from exc
+ current_app.logger.error(str(exc))
+ raise DatabaseError(E.FAILED_GET_FILE_PATH % {"file_id": file_id}) from exc
if not file:
- error = f"File with ID {file_id} not found."
- raise RecordNotFound(error)
+ raise RecordNotFound(E.FAILED_GET_FILE_PATH % {"file_id": file_id})
return file.file_path
diff --git a/src/server/services/history_table.py b/src/server/services/history_table.py
index ff97c18e..c15f2c47 100644
--- a/src/server/services/history_table.py
+++ b/src/server/services/history_table.py
@@ -11,11 +11,18 @@
from flask import current_app
from sqlalchemy import func
+from sqlalchemy.exc import SQLAlchemyError
from sqlalchemy.orm import selectinload
from server.db import db
-from server.db.history import Files, UploadHistory
-from server.exc import InvalidQueryError, InvalidRecordError, RecordNotFound
+from server.db.history import DownloadHistory, Files, UploadHistory
+from server.exc import (
+ DatabaseError,
+ InvalidQueryError,
+ InvalidRecordError,
+ RecordNotFound,
+)
+from server.messages import E
def get_upload_by_id(history_id: UUID) -> UploadHistory | None:
@@ -26,10 +33,20 @@ def get_upload_by_id(history_id: UUID) -> UploadHistory | None:
Returns:
UploadHistory | None: The upload history record, or None if not found.
+
+ Raises:
+ DatabaseError: If there is an error querying the database.
"""
- return db.session.get(
- UploadHistory, history_id, options=[selectinload(UploadHistory.file)]
- )
+ try:
+ history = db.session.get(
+ UploadHistory, history_id, options=[selectinload(UploadHistory.file)]
+ )
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_GET_UPLOAD_HISTORY_RECORD % {"history_id": history_id}
+ ) from exc
+ return history
def get_upload_results(history_id: UUID, attribute: str) -> dict:
@@ -41,14 +58,27 @@ def get_upload_results(history_id: UUID, attribute: str) -> dict:
Returns:
dict: The upload results for the specified attribute.
+
+ Raises:
+ DatabaseError: If there is an error querying the database.
+ RecordNotFound: If no history record is found for the given ID.
"""
- result = (
- db.session
- .query(UploadHistory.results[attribute])
- .filter(UploadHistory.id == history_id)
- .first()
- )
- return result[0] if result else {}
+ try:
+ result = (
+ db.session
+ .query(UploadHistory.results[attribute])
+ .filter(UploadHistory.id == history_id)
+ .first()
+ )
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_GET_UPLOAD_HISTORY_RECORD % {"history_id": history_id}
+ ) from exc
+ if result is None:
+ current_app.logger.error(E.FAILED_GET_FILE_RECORD, {"file_id": history_id})
+ raise RecordNotFound(E.FAILED_GET_FILE_RECORD % {"file_id": history_id})
+ return result[0]
def get_paginated_upload_results(
@@ -67,34 +97,40 @@ def get_paginated_upload_results(
Raises:
InvalidQueryError: If offset or size is less than 1.
+ DatabaseError: If there is an error querying the database.
"""
if offset < 1 or size < 1:
- error_message = "Invalid offset or size"
- raise InvalidQueryError(error_message)
+ current_app.logger.error(E.INVALID_QUERY, {"offset": offset, "size": size})
+ raise InvalidQueryError(E.INVALID_QUERY % {"offset": offset, "size": size})
elements = func.jsonb_array_elements(
UploadHistory.results["results"]
).column_valued("item")
- query = (
- db.session
- .query(elements)
- .select_from(UploadHistory)
- .filter(UploadHistory.id == history_id)
- )
-
- if status_filter:
- query = query.filter(elements.op("->>")("status").in_(status_filter))
-
- offset_val = (offset - 1) * size
-
- raw_results = query.limit(size).offset(offset_val).all()
-
+ try:
+ query = (
+ db.session
+ .query(elements)
+ .select_from(UploadHistory)
+ .filter(UploadHistory.id == history_id)
+ )
+
+ if status_filter:
+ query = query.filter(elements.op("->>")("status").in_(status_filter))
+
+ offset_val = (offset - 1) * size
+
+ raw_results = query.limit(size).offset(offset_val).all()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_GET_UPLOAD_HISTORY_RECORD % {"history_id": history_id}
+ ) from exc
return [r[0] for r in raw_results]
def create_upload(
file_id: UUID, results: dict, operator_id: str, operator_name: str
-) -> UUID:
+) -> UploadHistory:
"""Create a new upload history record.
Args:
@@ -104,30 +140,36 @@ def create_upload(
operator_name (str): The name of the operator performing the upload.
Returns:
- UUID: The ID of the newly created upload history record.
+ UploadHistory: The newly created upload history record.
Raises:
InvalidRecordError: If the results dictionary is missing required keys.
+ DatabaseError:
+ If there is an error creating the upload history record in the database.
"""
- history_record = UploadHistory()
- history_record.file_id = file_id
summary = results.get("summary")
items = results.get("results")
missing_users = results.get("missing_users", [])
if summary is None or items is None:
- error_message = "Results must include 'summary' and 'results' keys"
- raise InvalidRecordError(error_message)
-
- history_record.results = {
- "summary": summary,
- "items": items,
- "missing_users": missing_users,
- }
- history_record.operator_id = operator_id
- history_record.operator_name = operator_name
- db.session.add(history_record)
- db.session.commit()
- return history_record.id
+ raise InvalidRecordError(E.INVALID_UPLOAD_HISTORY_RECORD_ATTRIBUTES)
+ try:
+ history_record = UploadHistory()
+ history_record.file_id = file_id
+ history_record.results = {
+ "summary": summary,
+ "items": items,
+ "missing_users": missing_users,
+ }
+ history_record.operator_id = operator_id
+ history_record.operator_name = operator_name
+ db.session.add(history_record)
+ db.session.commit()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_CREATE_UPLOAD_HISTORY_RECORD % {"file_id": file_id}
+ ) from exc
+ return history_record
def update_upload_status(
@@ -138,34 +180,43 @@ def update_upload_status(
) -> None:
"""Update the status of an upload history record.
+ Must call db.session.commit() after using this function to persist changes.
+
Args:
history_id (UUID): The ID of the history record to update.
status (Literal["P", "S", "F"]):
The new status ("P": Progress, "S": Success, "F": Failed).
new_results (dict | None): New results to update, if any.
file_id (UUID | None): New file ID to update, if any.
- """
- obj = db.session.get(UploadHistory, history_id)
- if obj is None:
- return
- if new_results:
- obj.results = {
- "summary": new_results.get("summary", {}),
- "items": new_results.get("results", []),
- "missing_users": new_results.get("missing_users", []),
- }
- obj.status = status
- now = datetime.now(UTC)
- if status == "P":
- obj.timestamp = now
- else:
- obj.end_timestamp = now
-
- if file_id:
- obj.file_id = file_id
-
- db.session.commit()
+ Raises:
+ DatabaseError: If there is an error updating the database.
+ """
+ try:
+ obj = db.session.get(UploadHistory, history_id)
+ if obj is None:
+ return
+ if new_results:
+ obj.results = {
+ "summary": new_results.get("summary", {}),
+ "items": new_results.get("results", []),
+ "missing_users": new_results.get("missing_users", []),
+ }
+
+ obj.status = status
+ now = datetime.now(UTC)
+ if status == "P":
+ obj.timestamp = now
+ else:
+ obj.end_timestamp = now
+
+ if file_id:
+ obj.file_id = file_id
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_UPDATE_HISTORY_RECORD_STATUS % {"history_id": history_id}
+ ) from exc
def get_history_by_file_id(file_id: UUID) -> UploadHistory:
@@ -179,12 +230,24 @@ def get_history_by_file_id(file_id: UUID) -> UploadHistory:
Raises:
RecordNotFound: If no history record is found for the file ID.
+ DatabaseError: If there is an error querying the database.
"""
- result = db.session.query(UploadHistory).filter_by(file_id=file_id).one_or_none()
+ try:
+ result = (
+ db.session.query(UploadHistory).filter_by(file_id=file_id).one_or_none()
+ )
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_GET_UPLOAD_HISTORY_RECORD_BY_FILE_ID % {"file_id": file_id}
+ ) from exc
if result is None:
- error = f"History not found for file_id: {file_id}"
- current_app.logger.error(error)
- raise RecordNotFound(error)
+ current_app.logger.error(
+ E.FAILED_GET_UPLOAD_HISTORY_RECORD_BY_FILE_ID, {"file_id": file_id}
+ )
+ raise RecordNotFound(
+ E.FAILED_GET_UPLOAD_HISTORY_RECORD_BY_FILE_ID % {"file_id": file_id}
+ )
return result
@@ -199,47 +262,109 @@ def get_file_by_id(file_id: UUID) -> Files:
Raises:
RecordNotFound: If no file record is found for the file ID.
+ DatabaseError: If there is an error querying the database.
"""
- result = db.session.query(Files).filter_by(id=file_id).one_or_none()
+ try:
+ result = db.session.query(Files).filter_by(id=file_id).one_or_none()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(E.FAILED_GET_FILE_RECORD % {"file_id": file_id}) from exc
if result is None:
- error = f"File not found for file_id: {file_id}"
- current_app.logger.error(error)
- raise RecordNotFound(error)
+ current_app.logger.error(E.FAILED_GET_FILE_RECORD, {"file_id": file_id})
+ raise RecordNotFound(E.FAILED_GET_FILE_RECORD % {"file_id": file_id})
return result
def delete_file_by_id(file_id: UUID) -> None:
"""Delete a file record by its ID.
+ Must call db.session.commit() after using this function to persist changes.
+
Args:
file_id (UUID): The ID of the file to delete.
+
+ Raises:
+ DatabaseError: If there is an error deleting the file from the database.
"""
- Files.query.filter(Files.id == file_id).delete()
- db.session.commit()
+ try:
+ Files.query.filter(Files.id == file_id).delete()
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(E.FAILED_DELETE_FILE_RECORD % {"file_id": file_id}) from exc
def create_file(
file_path: str, file_content: dict, file_id: UUID | None = None
-) -> UUID:
+) -> Files:
"""Create or update a file record.
+ Must call db.session.commit() after using this function to persist changes.
+
Args:
file_path (str): The path of the file.
file_content (dict): The content of the file.
file_id (UUID | None): The ID of the file to update.
Returns:
- UUID: The ID of the created or updated file.
+ Files: The created or updated file record.
+
+ Raises:
+ DatabaseError: If there is an error creating the file record in the database.
+ """
+ try:
+ file_record = Files()
+ if file_id:
+ file_record.id = file_id
+ file_record.file_path = str(file_path)
+ file_record.file_content = {
+ "repositories": file_content.get("repositories", []),
+ "groups": file_content.get("groups", []),
+ "users": file_content.get("users", []),
+ }
+ db.session.add(file_record)
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_CREATE_FILE_RECORD % {"file_path": file_path}
+ ) from exc
+ return file_record
+
+
+def create_download_history(
+ file_id: UUID,
+ file_path: str,
+ file_content: dict,
+ operator_id: str,
+ operator_name: str,
+) -> DownloadHistory:
+ """Create a new download history record.
+
+ Must call db.session.commit() after using this function to persist changes.
+
+ Args:
+ file_id (UUID): The ID of the associated file.
+ file_path (str): The path of the file.
+ file_content (dict): The content of the file.
+ operator_id (str): The ID of the operator performing the download.
+ operator_name (str): The name of the operator performing the download.
+
+ Returns:
+ DownloadHistory: The newly created download history record.
+
+ Raises:
+ DatabaseError:
+ If there is an error creating the download history record in the database.
"""
- file_record = Files()
- if file_id:
- file_record.id = file_id
- file_record.file_path = str(file_path)
- file_record.file_content = {
- "repositories": file_content.get("repositories", []),
- "groups": file_content.get("groups", []),
- "users": file_content.get("users", []),
- }
- db.session.add(file_record)
- db.session.commit()
- return file_record.id
+ try:
+ create_file(file_path, file_content, file_id)
+ download_history = DownloadHistory()
+ download_history.file_id = file_id
+ download_history.operator_id = operator_id
+ download_history.operator_name = operator_name
+ db.session.add(download_history)
+ except SQLAlchemyError as exc:
+ current_app.logger.error(str(exc))
+ raise DatabaseError(
+ E.FAILED_CREATE_DOWNLOAD_HISTORY_RECORD % {"file_id": file_id}
+ ) from exc
+ return download_history
diff --git a/src/server/services/users.py b/src/server/services/users.py
index b1ac0b81..cfc7b7e0 100644
--- a/src/server/services/users.py
+++ b/src/server/services/users.py
@@ -7,7 +7,10 @@
import re
import typing as t
+from datetime import UTC, datetime
from http import HTTPStatus
+from pathlib import Path
+from uuid import uuid7
import requests
@@ -23,7 +26,9 @@
MAP_NO_RIGHTS_APPEND_PATTERN,
MAP_NO_RIGHTS_UPDATE_PATTERN,
MAP_NOT_FOUND_PATTERN,
+ USER_ROLES,
)
+from server.db import db
from server.entities.map_error import MapError
from server.entities.search_request import SearchResponse, SearchResult
from server.entities.summaries import UserSummary
@@ -32,6 +37,7 @@
ApiClientError,
ApiRequestError,
CredentialsError,
+ InvalidExportError,
InvalidFormError,
InvalidQueryError,
OAuthTokenError,
@@ -40,6 +46,9 @@
UnexpectedResponseError,
)
from server.messages import E, I
+from server.services import history_table
+from server.services.utils.affiliations import detect_affiliations
+from server.services.utils.permissions import get_permitted_repository_ids
from server.signals import user_deleted, user_updated
from .token import get_access_token, get_client_secret
@@ -55,6 +64,7 @@
if t.TYPE_CHECKING:
+ from server.api.schemas import FileQuery
from server.clients.users import UsersSearchResponse
from server.entities.map_user import Group, MapUser
from server.entities.patch_request import PatchOperation
@@ -733,3 +743,120 @@ def handle_user_updated(
users.get_by_id.clear_cache(user.id) # pyright: ignore[reportFunctionMemberAccess]
if user.eppns:
users.get_by_eppn.clear_cache(*user.eppns) # pyright: ignore[reportFunctionMemberAccess]
+
+
+def make_export_file(
+ operator_id: str, operator_name: str, query: FileQuery | None = None
+) -> Path:
+ """Generate a file containing user details for the specified user IDs.
+
+ Args:
+ operator_id (str): The ID of the operator performing the export.
+ operator_name (str): The name of the operator performing the export.
+ query (FileQuery | None):
+ The file query containing export format and other parameters.
+
+ Returns:
+ Path: The path to the generated export file.
+ """
+ query = query or FileQuery(f="tsv")
+ user_list = search(make_criteria_object("users", i=query.i), raw=True).resources
+ delimiter = "," if query.f == "csv" else "\t"
+ file_id = uuid7()
+ target_dir = Path(config.STORAGE.local.storage) / datetime.now(UTC).strftime(
+ "%Y/%m"
+ )
+ target_dir.mkdir(parents=True, exist_ok=True)
+ file_path = target_dir / f"{file_id}.{query.f}"
+ file_path.write_text(delimiter.join(config.USERS.export_fields), encoding="utf-8")
+
+ permitted_repository_ids = get_permitted_repository_ids()
+
+ file_repositories, file_groups, file_users = _wite_user(
+ user_list, delimiter, file_path, permitted_repository_ids
+ )
+ file_content = {
+ "repositories": list(file_repositories),
+ "groups": list(file_groups),
+ "users": list(file_users),
+ }
+ history_table.create_download_history(
+ file_id, str(file_path), file_content, operator_id, operator_name
+ )
+ db.session.commit()
+ return file_path
+
+
+def _wite_user(
+ user_list: list[MapUser],
+ delimiter: str,
+ file_path: Path,
+ permitted_repository_ids: set[str],
+) -> tuple[set[dict[str, str]], set[dict[str, str]], set[dict[str, str]]]:
+ """Write user details to file.
+
+ Args:
+ user_list (list[MapUser]): A list of user details.
+ delimiter (str): The delimiter to use in the file.
+ file_path (Path): The path to the file.
+ permitted_repository_ids (list[str]): A list of permitted repository IDs.
+
+ Returns:
+ tuple[set[dict[str, str]], set[dict[str, str]], set[dict[str, str]]]:
+ A tuple containing sets of file repositories, file groups, and file users.
+
+ Raises:
+ InvalidExportError:
+ If the user cannot be exported due to insufficient permissions.
+ """
+ file_repositories = set[dict[str, str]]()
+ file_groups = set[dict[str, str]]()
+ file_users = set[dict[str, str]]()
+ for map_user in user_list:
+ roles, groups = detect_affiliations([g.value for g in map_user.groups or []])
+ if not is_current_user_system_admin() and any(
+ role.role == USER_ROLES.SYSTEM_ADMIN for role in roles
+ ):
+ error = E.USER_CANNOT_EXPORT_SYSTEM_ADMIN
+ raise InvalidExportError(error)
+ if not is_current_user_system_admin() and not any(
+ group.repository_id in permitted_repository_ids for group in groups
+ ):
+ error = E.USER_FORBIDDEN_EXPORT
+ raise InvalidExportError(error)
+
+ file_users.add({"id": map_user.id or "", "user_name": map_user.user_name or ""})
+ group_ids = []
+ for group in groups:
+ if group.repository_id not in permitted_repository_ids:
+ continue
+
+ file_groups.add({"id": group.group_id or "", "display_name": ""})
+ file_repositories.add({"id": group.repository_id or "", "display_name": ""})
+ group_ids.append(group.group_id or "")
+ roles_list = [
+ r.role.value for r in roles if r.repository_id in permitted_repository_ids
+ ] or [""]
+ eppns = [eppn.value for eppn in map_user.edu_person_principal_names or []]
+ emails = [email.value for email in map_user.emails or []]
+
+ max_len = max(len(group_ids), len(roles_list), len(eppns), len(emails))
+
+ for i in range(max_len):
+ row = [
+ map_user.id,
+ map_user.user_name,
+ group_ids[i] if i < len(group_ids) else group_ids[len(group_ids) - 1],
+ "", # group name is not exported. it can't be get from mAP Core API search user endpoint # noqa: E501
+ roles_list[i]
+ if i < len(roles_list)
+ else roles_list[len(roles_list) - 1],
+ eppns[i] if i < len(eppns) else eppns[len(eppns) - 1],
+ map_user.preferred_language or "",
+ emails[i] if i < len(emails) else emails[len(emails) - 1],
+ ]
+ file_path.write_text(
+ delimiter.join(row) + "\n",
+ encoding="utf-8",
+ )
+ return file_repositories, file_groups, file_users
diff --git a/src/server/services/utils/__init__.py b/src/server/services/utils/__init__.py
index 686dd1b8..b514cf31 100644
--- a/src/server/services/utils/__init__.py
+++ b/src/server/services/utils/__init__.py
@@ -5,7 +5,7 @@
"""Provides utilities for service."""
from .affiliations import detect_affiliation, detect_affiliations, detect_repository
-from .decoraters import session_required
+from .decoraters import require_enabled, session_required
from .filter_options import (
search_groups_options,
search_history_filter_options,
diff --git a/src/server/services/utils/decoraters.py b/src/server/services/utils/decoraters.py
index ef52fea6..e877dddc 100644
--- a/src/server/services/utils/decoraters.py
+++ b/src/server/services/utils/decoraters.py
@@ -8,6 +8,10 @@
from functools import wraps
+from flask import abort
+
+from server.config import config
+
def session_required[**P, R](func: t.Callable[P, R]) -> t.Callable[..., R]:
"""Decorator to ensure that a valid session exists.
@@ -24,3 +28,18 @@ def wrapper(*args: P.args, session_id: str | None = None, **kwargs: P.kwargs) ->
return func(*args, **kwargs)
return wrapper
+
+
+def require_enabled[**P, R](setting: t.Literal["enable_bulk_operation"]): # noqa: ANN201, D103
+
+ def decorator(func): # noqa: ANN001, ANN202
+
+ @wraps(func)
+ def wrapper(*args, **kwargs): # noqa: ANN002, ANN003, ANN202
+ if not getattr(config.FEATURES, setting, False):
+ abort(404)
+ return func(*args, **kwargs)
+
+ return wrapper
+
+ return decorator
diff --git a/src/server/services/utils/permissions.py b/src/server/services/utils/permissions.py
index 65d28a9d..87abf627 100644
--- a/src/server/services/utils/permissions.py
+++ b/src/server/services/utils/permissions.py
@@ -60,12 +60,12 @@ def get_permitted_repository_ids() -> set[str]:
is_member_of: str = current_user.is_member_of
group_ids = extract_group_ids(is_member_of)
- affiliations, _ = detect_affiliations(group_ids)
+ roles = detect_affiliations(group_ids).roles
return {
aff.repository_id
- for aff in affiliations
- if aff.repository_id and aff.role == USER_ROLES.REPOSITORY_ADMIN
+ for aff in roles
+ if aff.repository_id and USER_ROLES.REPOSITORY_ADMIN in aff.role
}
diff --git a/src/server/services/utils/search_queries.py b/src/server/services/utils/search_queries.py
index e502dd65..aa2fab43 100644
--- a/src/server/services/utils/search_queries.py
+++ b/src/server/services/utils/search_queries.py
@@ -241,7 +241,7 @@ def _group_groups_filter(criteria: GroupsCriteria, id_path: str) -> str:
return _all_repository_all_group_filter(id_path)
case _:
error = E.UNRECOGNIZED_SEARCH_CRITERIA
- raise InvalidQueryError(error) # pragma: no cover
+ raise InvalidQueryError(error)
def build_users_search_query(criteria: UsersCriteria) -> SearchRequestParameter:
@@ -271,13 +271,13 @@ def build_users_search_query(criteria: UsersCriteria) -> SearchRequestParameter:
if criteria.q:
# partial match search on user_name, emails, edu_person_principal_names
- filter_expr.append(
- " or ".join([
- f'({path("user_name")} co "{criteria.q}")',
+ term_filter = [f'({path("user_name")} co "{criteria.q}")']
+ if not config.FEATURES.search_only_username:
+ term_filter.extend([
f'({path("emails.value")} co "{criteria.q}")',
f'({path("edu_person_principal_names.value")} co "{criteria.q}")',
])
- )
+ filter_expr.append(" or ".join(term_filter))
if criteria.i:
# exact match search on IDs
@@ -346,7 +346,6 @@ def _user_groups_filter(criteria: UsersCriteria, path: str) -> str:
_repository_admin_user_groups_filter(
criteria, path, permitted, specified_roles
),
- f'{path} ne "{config.GROUPS.id_patterns.system_admin}"',
]
return t.cast("str", _combine_filter_exprs(filter_expr))
@@ -380,9 +379,9 @@ def _system_admin_user_groups_filter( # noqa: PLR0911
case (None, None, None):
return _all_repository_all_group_filter(path)
- case _:
+ case _: # pragma: no cover
error = E.UNRECOGNIZED_SEARCH_CRITERIA
- raise InvalidQueryError(error) # pragma: no cover
+ raise InvalidQueryError(error)
def _repository_admin_user_groups_filter(
@@ -409,9 +408,9 @@ def _repository_admin_user_groups_filter(
)
case (None, None):
return _specified_repository_all_group_filter(path, list(permitted))
- case _:
+ case _: # pragma: no cover
error = E.UNRECOGNIZED_SEARCH_CRITERIA
- raise InvalidQueryError(error) # pragma: no cover
+ raise InvalidQueryError(error)
@cache
@@ -454,6 +453,13 @@ def _all_repository_specified_role_filter(path: str, roles: list[USER_ROLES]) ->
prefix, suffix = id_patterns[role]
filters.append(f'{path} sw "{prefix}" and {path} ew "{suffix}"')
+ if USER_ROLES.SYSTEM_ADMIN not in roles:
+ return (
+ f'{path} ne "{config.GROUPS.id_patterns.system_admin}" and ('
+ + " or ".join(filters)
+ + ")"
+ )
+
return " or ".join(filters)
@@ -462,7 +468,13 @@ def _all_repository_specified_group_filter(path: str, group_ids: list[str]) -> s
Filter by exact match for group IDs without specifying a repository.
"""
- return " or ".join([f'{path} eq "{group_id}"' for group_id in group_ids])
+ if path == "id":
+ return " or ".join([f'{path} eq "{group_id}"' for group_id in group_ids])
+ return (
+ f'{path} ne "{config.GROUPS.id_patterns.system_admin}" and ('
+ + " or ".join([f'{path} eq "{group_id}"' for group_id in group_ids])
+ + ")"
+ )
def _all_repository_specified_role_specified_group_filter(
@@ -484,11 +496,21 @@ def _specified_repository_all_group_filter(path: str, repository_ids: list[str])
Filter by prefix match for group IDs within specified repositories.
"""
prefix_patterns = _get_prefix_patterns()
- return " or ".join([
- f'{path} sw "{prefix}{repo_id}"'
- for prefix in prefix_patterns
- for repo_id in repository_ids
- ])
+ if path == "id":
+ return " or ".join([
+ f'{path} sw "{prefix}{repo_id}"'
+ for prefix in prefix_patterns
+ for repo_id in repository_ids
+ ])
+ return (
+ f'{path} ne "{config.GROUPS.id_patterns.system_admin}" and ('
+ + " or ".join([
+ f'{path} sw "{prefix}{repo_id}"'
+ for prefix in prefix_patterns
+ for repo_id in repository_ids
+ ])
+ + ")"
+ )
def _specified_repository_specified_role_filter(
@@ -498,6 +520,9 @@ def _specified_repository_specified_role_filter(
Filter by exact match for role-type group IDs within specified repositories.
"""
+ if not roles:
+ return _empty_filter(path)
+
filters: list[str] = []
for role in roles:
if role == USER_ROLES.SYSTEM_ADMIN:
@@ -510,7 +535,11 @@ def _specified_repository_specified_role_filter(
for repo_id in repository_ids
)
- return " or ".join(filters)
+ return (
+ f'{path} ne "{config.GROUPS.id_patterns.system_admin}" and ('
+ + " or ".join(filters)
+ + ")"
+ )
def _specified_repository_specified_group_filter(
@@ -524,7 +553,13 @@ def _specified_repository_specified_group_filter(
# filter by repository IDs that the specified group belongs to
filtered_groups = [aff for aff in groups if aff.repository_id in repository_ids]
if filtered_groups:
- return " or ".join([f'{path} eq "{g.group_id}"' for g in filtered_groups])
+ if path == "id":
+ return " or ".join([f'{path} eq "{g.group_id}"' for g in filtered_groups])
+ return (
+ f'{path} ne "{config.GROUPS.id_patterns.system_admin}" and ('
+ + " or ".join([f'{path} eq "{g.group_id}"' for g in filtered_groups])
+ + ")"
+ )
return _empty_filter(path)
@@ -903,7 +938,7 @@ def make_criteria_object(resource_type: str, **kwargs: t.Any) -> Criteria: # py
protocol_cls = RepositoriesCriteria
case _:
error = E.UNRECOGNIZED_SEARCH_CRITERIA
- raise InvalidQueryError(error) # pragma: no cover
+ raise InvalidQueryError(error)
hints = t.get_type_hints(protocol_cls)
diff --git a/src/server/services/utils/transformers.py b/src/server/services/utils/transformers.py
index 78ddb642..f3ca70fe 100644
--- a/src/server/services/utils/transformers.py
+++ b/src/server/services/utils/transformers.py
@@ -25,7 +25,7 @@
Service as GroupService,
)
from server.entities.map_service import (
- Administrator,
+ Administrator as ServiceAdministrator,
Group as MapServiceGroup,
MapService,
ServiceEntityID,
@@ -69,7 +69,7 @@ def prepare_service(
raise SystemAdminNotFound(error)
service.administrators = [
- Administrator(value=user_id) for user_id in administrators
+ ServiceAdministrator(value=user_id) for user_id in administrators
]
service.groups = [
MapServiceGroup(
@@ -357,7 +357,7 @@ def validate_group_to_map_group(
) -> MapGroup: ...
-def validate_group_to_map_group( # noqa: C901, PLR0912
+def validate_group_to_map_group(
group: GroupDetail, *, mode: t.Literal["create", "update"]
) -> tuple[MapGroup, str] | MapGroup:
"""Validate the GroupDetail instance and convert it to a MapGroup instance.
@@ -420,10 +420,10 @@ def validate_group_to_map_group( # noqa: C901, PLR0912
error = E.GROUP_TOO_LONG_ID % {"rid": repository_id, "max": max_id_length}
raise InvalidFormError(error)
- id_pattern = config.GROUPS.id_patterns.user_defined
- group.id = id_pattern.format(
- repository_id=repository_id, user_defined_id=user_defined_id
- )
+ id_pattern = config.GROUPS.id_patterns.user_defined
+ group.id = id_pattern.format(
+ repository_id=repository_id, user_defined_id=user_defined_id
+ )
if group.public is None:
group.public = GROUP_DEFAULT_PUBLIC
diff --git a/tests/data/map_bulk.json b/tests/data/map_bulk.json
new file mode 100644
index 00000000..17eeecc8
--- /dev/null
+++ b/tests/data/map_bulk.json
@@ -0,0 +1,99 @@
+{
+ "schemas": [
+ "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
+ ],
+ "operations": [
+ {
+ "method": "PUT",
+ "path": "Groups/c8fdd6b4-35b6-41b8-959b-0e24b9a9700d",
+ "data": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:mace:example.jp:core:2.0:Group"
+ ],
+ "id": "c8fdd6b4-35b6-41b8-959b-0e24b9a9700d",
+ "externalId": null,
+ "displayName": "JAIRO test group UPDATED",
+ "public": false,
+ "description": "Created by John Doe",
+ "suspended": false,
+ "memberListVisibility": "Private",
+ "meta": {
+ "resourceType": "Group",
+ "created": "2025-08-28T02:03:40Z",
+ "lastModified": "2025-08-28T02:03:40Z"
+ },
+ "members": [
+ {
+ "$ref": "https://sptest.cg.example.jp/api/v2/Users/00404105-6f3e-47bb-b839-ad093153b34c",
+ "type": "User",
+ "display": "John Doe",
+ "value": "00404105-6f3e-47bb-b839-ad093153b34c",
+ "customRoles": null
+ }
+ ],
+ "administrators": [
+ {
+ "$ref": "https://sptest.cg.example.jp/api/v2/Users/00404105-6f3e-47bb-b839-ad093153b34c",
+ "display": "John Doe",
+ "value": "00404105-6f3e-47bb-b839-ad093153b34c"
+ }
+ ],
+ "services": [
+ {
+ "$ref": "https://sptest.cg.example.jp/api/v2/Services/jairocloud-groups-manager",
+ "display": "JAIRO Cloud Groups Manager",
+ "value": "jairocloud-groups-manager",
+ "administratorOfGroup": 0
+ }
+ ]
+ },
+ "response": {
+ "schemas": [
+ "urn:ietf:params:scim:schemas:mace:example.jp:core:2.0:Group"
+ ],
+ "id": "c8fdd6b4-35b6-41b8-959b-0e24b9a9700d",
+ "externalId": null,
+ "displayName": "JAIRO test group UPDATED",
+ "public": false,
+ "description": "Created by John Doe",
+ "suspended": false,
+ "memberListVisibility": "Private",
+ "meta": {
+ "resourceType": "Group",
+ "created": "2025-08-28T02:03:40Z",
+ "lastModified": "2025-08-28T02:03:40Z"
+ },
+ "members": [
+ {
+ "$ref": "https://sptest.cg.example.jp/api/v2/Users/00404105-6f3e-47bb-b839-ad093153b34c",
+ "type": "User",
+ "display": "John Doe",
+ "value": "00404105-6f3e-47bb-b839-ad093153b34c",
+ "customRoles": null
+ }
+ ],
+ "administrators": [
+ {
+ "$ref": "https://sptest.cg.example.jp/api/v2/Users/00404105-6f3e-47bb-b839-ad093153b34c",
+ "display": "John Doe",
+ "value": "00404105-6f3e-47bb-b839-ad093153b34c"
+ }
+ ],
+ "services": [
+ {
+ "$ref": "https://sptest.cg.example.jp/api/v2/Services/jairocloud-groups-manager",
+ "display": "JAIRO Cloud Groups Manager",
+ "value": "jairocloud-groups-manager",
+ "administratorOfGroup": 0
+ }
+ ]
+ },
+ "status": "200"
+ },
+ {
+ "method": "DELETE",
+ "path": "Users/00404105-6f3e-47bb-b839-ad093153b34c",
+ "status": "204"
+ }
+ ]
+}
diff --git a/tests/unit/api/test_auth.py b/tests/unit/api/test_auth.py
new file mode 100644
index 00000000..57f06c90
--- /dev/null
+++ b/tests/unit/api/test_auth.py
@@ -0,0 +1,182 @@
+import typing as t
+
+from http import HTTPStatus
+
+import pytest
+
+from flask import session
+from flask_login import current_user, login_user
+
+from server.api import auth
+from server.const import USER_ROLES
+from server.entities.login_user import LoginUser
+from server.entities.summaries import GroupSummary
+from server.entities.user_detail import UserDetail
+from server.services.utils.affiliations import Affiliations, _RoleGroup
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+mock_repoadmin_login_user = LoginUser(
+ eppn="test_eppn",
+ is_member_of="https://cg.gakunin.jp/gr/jc_test_roles_repoadm;https://cg.gakunin.jp/gr/group1",
+ user_name="Test User",
+ map_id="test_user_id",
+ session_id="",
+)
+mock_repoadmin_user_detail = UserDetail(
+ id="test_user_id",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ groups=[GroupSummary(id="jc_test_roles_repoadm"), GroupSummary(id="group1")],
+)
+
+
+def test_check(app):
+ with app.test_request_context("/api/auth/check"):
+ login_user(mock_repoadmin_login_user)
+ resp = auth.check()
+ assert resp.status_code == HTTPStatus.OK
+ data = resp.get_json()
+ assert data["id"] == mock_repoadmin_login_user.map_id
+ assert data["eppn"] == mock_repoadmin_login_user.eppn
+ assert data["userName"] == mock_repoadmin_login_user.user_name
+ assert data["isSystemAdmin"] is False
+
+
+def test_login_no_eppn(app):
+ with app.test_request_context(
+ "/api/auth/login",
+ headers={
+ "IsMemberOf": "https://cg.gakunin.jp/gr/jc_test_roles_repoadm;https://cg.gakunin.jp/gr/group1",
+ "DisplayName": "Test User",
+ },
+ ):
+ resp = auth.login()
+ assert current_user.is_anonymous
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/?error=401")
+
+
+def test_login_not_get_user(app, mocker: MockerFixture):
+ with app.test_request_context(
+ "/api/auth/login",
+ headers={
+ "eppn": "test_eppn",
+ "IsMemberOf": "https://cg.gakunin.jp/gr/jc_test_roles_repoadm;https://cg.gakunin.jp/gr/group1",
+ "DisplayName": "Test User",
+ },
+ ):
+ mocker.patch("server.services.users.get_by_eppn", return_value=None)
+ resp = auth.login()
+ assert current_user.is_anonymous
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/?error=401")
+
+
+def test_login_not_is_member_of(app, mocker: MockerFixture):
+ mock_affiliations = Affiliations(
+ roles=[_RoleGroup(repository_id="test", role=USER_ROLES.REPOSITORY_ADMIN)], groups=[]
+ )
+ excepted_is_member_of = "https://cg.gakunin.jp/gr/jc_test_roles_repoadm;https://cg.gakunin.jp/gr/group1"
+ with app.test_request_context(
+ "/api/auth/login",
+ headers={
+ "eppn": "test_eppn",
+ "DisplayName": "Test User",
+ },
+ ):
+ mocker.patch("server.services.users.get_by_eppn", return_value=mock_repoadmin_user_detail)
+ mocker.patch("server.api.auth.detect_affiliations", return_value=mock_affiliations)
+ resp = auth.login()
+ assert current_user.is_member_of == excepted_is_member_of
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/")
+
+
+def test_login_not_user_name(app, mocker: MockerFixture):
+ mock_affiliations = Affiliations(
+ roles=[_RoleGroup(repository_id="test", role=USER_ROLES.REPOSITORY_ADMIN)], groups=[]
+ )
+ with app.test_request_context(
+ "/api/auth/login",
+ headers={
+ "eppn": "test_eppn",
+ "IsMemberOf": "https://cg.gakunin.jp/gr/jc_test_roles_repoadm;https://cg.gakunin.jp/gr/group1",
+ },
+ ):
+ mocker.patch("server.services.users.get_by_eppn", return_value=mock_repoadmin_user_detail)
+ mocker.patch("server.api.auth.detect_affiliations", return_value=mock_affiliations)
+ resp = auth.login()
+ assert current_user.user_name == mock_repoadmin_login_user.user_name
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/")
+
+
+def test_login_not_admin(app, mocker: MockerFixture):
+ with app.test_request_context(
+ "/api/auth/login",
+ headers={
+ "eppn": "test_eppn",
+ "IsMemberOf": "https://cg.gakunin.jp/gr/group1;https://cg.gakunin.jp/gr/group2",
+ "DisplayName": "Test User",
+ },
+ ):
+ mocker.patch("server.services.users.get_by_eppn", return_value=mock_repoadmin_user_detail)
+ mocker.patch("server.services.utils.permissions.extract_group_ids", return_value=["group1", "group2"])
+ resp = auth.login()
+ assert current_user.is_anonymous
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/?error=403")
+
+
+def test_login_no_session_ttl(app, mocker: MockerFixture, test_config):
+ mock_affiliations = Affiliations(
+ roles=[_RoleGroup(repository_id="test", role=USER_ROLES.REPOSITORY_ADMIN)], groups=[]
+ )
+ with app.test_request_context(
+ "/api/auth/login",
+ headers={
+ "eppn": "test_eppn",
+ "IsMemberOf": "https://cg.gakunin.jp/gr/jc_test_roles_repoadm;https://cg.gakunin.jp/gr/group1",
+ "DisplayName": "Test User",
+ },
+ ):
+ mocker.patch("server.services.users.get_by_eppn", return_value=mock_repoadmin_user_detail)
+ mocker.patch("server.api.auth.detect_affiliations", return_value=mock_affiliations)
+ mocker.patch.object(test_config.SESSION, "sliding_lifetime", -1)
+ resp = auth.login()
+ assert current_user.user_name == mock_repoadmin_login_user.user_name
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/")
+
+
+def test_login_next(app, mocker: MockerFixture):
+ mock_affiliations = Affiliations(roles=[_RoleGroup(repository_id=None, role=USER_ROLES.SYSTEM_ADMIN)], groups=[])
+ with app.test_request_context(
+ "/api/auth/login?next=users",
+ headers={
+ "eppn": "test_eppn",
+ "IsMemberOf": "https://cg.gakunin.jp/gr/group1;https://cg.gakunin.jp/gr/jc_roles_sysadm",
+ "DisplayName": "Test User",
+ },
+ ):
+ mocker.patch("server.services.users.get_by_eppn", return_value=mock_repoadmin_user_detail)
+ mocker.patch("server.api.auth.extract_group_ids", return_value=["group1", "jc_roles_sysadm"])
+ mocker.patch("server.api.auth.detect_affiliations", return_value=mock_affiliations)
+ resp = auth.login()
+ assert current_user.eppn == mock_repoadmin_login_user.eppn
+ assert resp.status_code == HTTPStatus.FOUND
+ assert resp.location.endswith("/?next=users")
+
+
+@pytest.mark.parametrize("session_id", ["test_eppn", None])
+def test_logout(app, session_id):
+ app.secret_key = "test-secret"
+ with app.test_request_context("/api/auth/logout"):
+ login_user(mock_repoadmin_login_user)
+ session["_id"] = session_id
+ resp, code = auth.logout()
+ assert resp == "" # noqa: PLC1901
+ assert code == HTTPStatus.NO_CONTENT
diff --git a/tests/unit/api/test_bulk.py b/tests/unit/api/test_bulk.py
new file mode 100644
index 00000000..3bb06492
--- /dev/null
+++ b/tests/unit/api/test_bulk.py
@@ -0,0 +1,265 @@
+import inspect
+import typing as t
+
+from datetime import UTC, datetime
+from http import HTTPStatus
+from uuid import UUID, uuid7
+
+from flask_login import login_user
+from redis.exceptions import ConnectionError as RedisConnectionError
+
+from server.api import bulk
+from server.api.schemas import BulkBody, ErrorResponse, ExcuteRequest, TargetRepository, UploadQuery
+from server.entities.bulk import HistorySummary, ResultSummary, ValidateSummary
+from server.entities.login_user import LoginUser
+from server.exc import InvalidRecordError, RecordNotFound
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+def test_upload_file(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.upload_file)
+ repository_id = "repo123"
+ operator_id = "user123"
+ operator_name = "test_user"
+ mock_user = LoginUser(eppn="test_eppn", is_member_of="", user_name=operator_name, map_id=operator_id, session_id="")
+ form = TargetRepository(repository_id=repository_id)
+ dummy_file = mocker.Mock(bulk_file=mocker.Mock(filename="test.csv", save=mocker.Mock()))
+ mock_task = mocker.Mock(id="task_id")
+ mock_create_file = mocker.patch("server.services.history_table.create_file", return_value=None)
+ mock_delete_temporary_file = mocker.patch(
+ "server.services.bulks.delete_temporary_file.apply_async", return_value=None
+ )
+ mock_validate_upload_data = mocker.patch(
+ "server.services.bulks.validate_upload_data.apply_async", return_value=mock_task
+ )
+ with app.test_request_context():
+ login_user(mock_user)
+ result = test_func(form=form, files=dummy_file)
+ assert result[0].task_id == mock_task.id
+ assert isinstance(result[0], BulkBody)
+ assert result[1] == HTTPStatus.OK
+ _, kwargs = mock_create_file.call_args
+ assert isinstance(kwargs["file_id"], UUID)
+ assert isinstance(kwargs["file_path"], str)
+ assert kwargs["file_content"] == {"repositories": [{"id": repository_id}]}
+ args, kwargs = mock_delete_temporary_file.call_args
+ assert isinstance(args[0][0], str)
+ assert isinstance(kwargs["countdown"], int)
+ args, kwargs = mock_validate_upload_data.call_args
+ assert args[0][0] == operator_id
+ assert args[0][1] == operator_name
+ assert isinstance(args[0][2], UUID)
+
+
+def test_validate_status(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_status)
+ mock_task = mocker.Mock()
+ mock_task.state = "SUCCESS"
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", return_value=mock_task)
+ expected = BulkBody(status=mock_task.state)
+ with app.test_request_context():
+ result = test_func(task_id)
+ assert result[0] == expected
+ assert result[1] == HTTPStatus.OK
+
+
+def test_validate_status_not_found(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_status)
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", return_value=None)
+ with app.test_request_context():
+ result = test_func(task_id)
+ assert result[0] == ErrorResponse(code="", message="Task not found: task_id")
+ assert result[1] == HTTPStatus.NOT_FOUND
+
+
+def test_validate_status_redis_error(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_status)
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", side_effect=RedisConnectionError)
+ with app.test_request_context():
+ result = test_func(task_id)
+ assert result[0] == ErrorResponse(code="", message=f"Failed to connect to Redis: {task_id}")
+ assert result[1] == HTTPStatus.INTERNAL_SERVER_ERROR
+
+
+def test_validate_result(app, mocker: MockerFixture):
+ task_id = "task_id"
+ history_id = uuid7()
+ test_func = inspect.unwrap(bulk.validate_result)
+ mock_task = mocker.Mock()
+ mock_task.result = history_id
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", return_value=mock_task)
+ expected = ValidateSummary(
+ results=[],
+ summary=HistorySummary(create=0, delete=0, error=0, skip=0, update=0),
+ missing_user=[],
+ offset=1,
+ page_size=50,
+ )
+ mock_validate_result = mocker.patch("server.services.bulks.get_validate_result", return_value=expected)
+ with app.test_request_context():
+ result = test_func(query=UploadQuery(f=[3], p=2, l=50), task_id=task_id)
+ assert result[0] == expected
+ assert result[1] == HTTPStatus.OK
+ mock_validate_result.assert_called_once_with(history_id=history_id, status_filter=["skip"], offset=2, size=50)
+
+
+def test_validate_result_failed(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_result)
+ mock_task = mocker.Mock()
+ mock_task.successful.return_value = False
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", return_value=mock_task)
+ with app.test_request_context():
+ result = test_func(query=UploadQuery(), task_id=task_id)
+ assert result[0] == ErrorResponse(code="", message=f"Task not successful: {task_id}")
+ assert result[1] == HTTPStatus.BAD_REQUEST
+
+
+def test_validate_result_not_found(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_result)
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", return_value=None)
+ with app.test_request_context():
+ result = test_func(query=UploadQuery(), task_id=task_id)
+ assert result[0] == ErrorResponse(code="", message=f"Task not found: {task_id}")
+ assert result[1] == HTTPStatus.NOT_FOUND
+
+
+def test_validate_result_redis_error(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_result)
+ mock_return_value = InvalidRecordError("Results must include 'summary' and 'results' keys")
+ mocker.patch(
+ "server.services.bulks.validate_upload_data.AsyncResult", return_value=mocker.Mock(result=mock_return_value)
+ )
+ with app.test_request_context():
+ result = test_func(query=UploadQuery(), task_id=task_id)
+ assert result[0] == ErrorResponse(code="", message=f"Task resulted in an exception: {mock_return_value}")
+ assert result[1] == HTTPStatus.BAD_REQUEST
+
+
+def test_validate_result_redis_connection_error(app, mocker: MockerFixture):
+ task_id = "task_id"
+ test_func = inspect.unwrap(bulk.validate_result)
+ mocker.patch("server.services.bulks.validate_upload_data.AsyncResult", side_effect=RedisConnectionError)
+ with app.test_request_context():
+ result = test_func(query=UploadQuery(), task_id=task_id)
+ assert result[0] == ErrorResponse(code="", message=f"Failed to connect to Redis: {task_id}")
+ assert result[1] == HTTPStatus.INTERNAL_SERVER_ERROR
+
+
+def test_execute(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.execute)
+ temp_id = uuid7()
+ repository_id = "repo1"
+ task_id = "task_id"
+ body = ExcuteRequest(
+ temp_file_id=temp_id,
+ repository_id=repository_id,
+ delete_users=["user1", "user2"],
+ )
+ history_id = uuid7()
+ mock_get_history_by_file_id = mocker.patch(
+ "server.services.history_table.get_history_by_file_id", return_value=mocker.Mock(id=history_id)
+ )
+ mock_execute_bulk_upload = mocker.patch(
+ "server.services.bulks.update_users.apply_async", return_value=mocker.Mock(id=task_id)
+ )
+ expected = BulkBody(task_id=task_id, history_id=history_id)
+ with app.test_request_context():
+ result = test_func(body)
+ assert result[0] == expected
+ assert result[1] == HTTPStatus.OK
+ mock_get_history_by_file_id.assert_called_once_with(temp_id)
+ mock_execute_bulk_upload.assert_called_once_with(
+ kwargs={"history_id": history_id, "temp_file_id": body.temp_file_id, "delete_users": body.delete_users}
+ )
+
+
+def test_execute_history_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.execute)
+ temp_id = uuid7()
+ body = ExcuteRequest(temp_file_id=temp_id)
+ mocker.patch(
+ "server.services.history_table.get_history_by_file_id", side_effect=RecordNotFound("History not found")
+ )
+ expected_message = "History not found"
+ with app.test_request_context():
+ result = test_func(body)
+ assert result[0] == ErrorResponse(code="", message=expected_message)
+ assert result[1] == HTTPStatus.NOT_FOUND
+
+
+def test_execute_status(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.execute_status)
+ task_id = "task_id"
+ mocker.patch("server.services.bulks.update_users.AsyncResult", return_value=mocker.Mock(state="SUCCESS"))
+ expected = BulkBody(status="SUCCESS")
+ with app.test_request_context():
+ result = test_func(task_id)
+ assert result[0] == expected
+ assert result[1] == HTTPStatus.OK
+
+
+def test_execute_status_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.execute_status)
+ task_id = "task_id"
+ mocker.patch("server.services.bulks.update_users.AsyncResult", return_value=None)
+ expected_message = "Task not found: task_id"
+ with app.test_request_context():
+ result = test_func(task_id)
+ assert result[0] == ErrorResponse(code="", message=expected_message)
+ assert result[1] == HTTPStatus.NOT_FOUND
+
+
+def test_execute_status_redis_error(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.execute_status)
+ task_id = "task_id"
+ mocker.patch("server.services.bulks.update_users.AsyncResult", side_effect=RedisConnectionError)
+ expected_message = f"Failed to connect to Redis: {task_id}"
+ with app.test_request_context():
+ result = test_func(task_id)
+ assert result[0] == ErrorResponse(code="", message=expected_message)
+ assert result[1] == HTTPStatus.INTERNAL_SERVER_ERROR
+
+
+def test_result(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.result)
+ history_id = uuid7()
+ expected_summary = ResultSummary(
+ items=[],
+ summary=HistorySummary(create=0, delete=0, error=0, skip=0, update=0),
+ file_id=uuid7(),
+ file_name="",
+ operator="",
+ start_timestamp=datetime.now(UTC),
+ end_timestamp=None,
+ total=0,
+ offset=2,
+ page_size=50,
+ )
+ mock_get_upload_result = mocker.patch("server.services.bulks.get_upload_result", return_value=expected_summary)
+ with app.test_request_context():
+ result = test_func(history_id, UploadQuery(f=[0, 1], p=2, l=50))
+ assert result[0] == expected_summary
+ assert result[1] == HTTPStatus.OK
+ mock_get_upload_result.assert_called_once_with(
+ history_id=history_id, status_filter=["create", "update"], offset=2, size=50
+ )
+
+
+def test_result_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(bulk.result)
+ history_id = uuid7()
+ mocker.patch("server.services.bulks.get_upload_result", side_effect=RecordNotFound("History not found"))
+ expected_message = "History not found"
+ with app.test_request_context():
+ result = test_func(history_id, UploadQuery())
+ assert result[0] == ErrorResponse(code="", message=expected_message)
+ assert result[1] == HTTPStatus.NOT_FOUND
diff --git a/tests/unit/api/test_history.py b/tests/unit/api/test_history.py
new file mode 100644
index 00000000..9bd97841
--- /dev/null
+++ b/tests/unit/api/test_history.py
@@ -0,0 +1,227 @@
+import inspect
+import typing as t
+
+from http import HTTPStatus
+from pathlib import Path
+from uuid import UUID
+
+import pytest
+
+from server.api import history
+from server.api.schemas import ErrorResponse, HistoryPublic, OperatorQuery
+from server.entities.history_detail import DownloadHistoryData, HistoryQuery, UploadHistoryData
+from server.entities.search_request import FilterOption, SearchResult
+from server.exc import DatabaseError, InvalidQueryError, RecordNotFound
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+def test_filter_options(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.filter_options)
+ with (
+ app.test_request_context("/"),
+ ):
+ expected = [
+ FilterOption(key="o", description="operator", type="string", multiple=True, items=[]),
+ FilterOption(
+ key="r",
+ description="repositories",
+ type="string",
+ multiple=True,
+ items=[],
+ ),
+ FilterOption(key="g", description="groups", type="string", multiple=True, items=[]),
+ FilterOption(key="u", description="users", type="string", multiple=True, items=[]),
+ ]
+ mock_get_filters = mocker.patch("server.api.history.search_history_filter_options", return_value=expected)
+ test_func()
+ mock_get_filters.assert_called_once_with()
+
+
+def test_filter_options_operators(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.filter_options_operators)
+ expected = SearchResult(total=0, page_size=20, offset=1, resources=[])
+ with (
+ app.test_request_context(),
+ ):
+ mock_get_filter_option = mocker.patch(
+ "server.services.history.get_filter_items",
+ return_value=expected,
+ )
+ resp = test_func(tab="download", query=OperatorQuery(p=1, l=20))
+ assert resp[0] == expected
+ assert resp[1] == HTTPStatus.OK
+ mock_get_filter_option.assert_called_once_with("download", key="o", criteria=OperatorQuery(q=None, p=1, l=20))
+
+
+def test_filter_options_operators_invalid_query(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.filter_options_operators)
+ with (
+ app.test_request_context(),
+ ):
+ exception_message = "Invalid Unsupported criteria type: DummyCriteria"
+ mock_get_filter_option = mocker.patch(
+ "server.services.history.get_filter_items",
+ side_effect=InvalidQueryError(exception_message),
+ )
+ resp = test_func(tab="download", query=OperatorQuery(p=0, l=20))
+ assert resp[0] == ErrorResponse(code="", message=exception_message)
+ assert resp[1] == HTTPStatus.BAD_REQUEST
+ mock_get_filter_option.assert_called_once_with("download", key="o", criteria=OperatorQuery(q=None, p=0, l=20))
+
+
+@pytest.mark.parametrize(
+ ("tab", "expected"),
+ [
+ ("download", SearchResult[DownloadHistoryData](total=0, page_size=20, offset=1, resources=[])),
+ ("upload", SearchResult[UploadHistoryData](total=0, page_size=20, offset=1, resources=[])),
+ ],
+)
+def test_get(app, mocker: MockerFixture, tab, expected):
+ test_func = inspect.unwrap(history.get)
+ with (
+ app.test_request_context(),
+ ):
+ mock_get_download_history = mocker.patch(
+ "server.services.history.get_download_history_data",
+ return_value=expected,
+ )
+ mock_get_upload_history = mocker.patch(
+ "server.services.history.get_upload_history_data",
+ return_value=expected,
+ )
+ resp = test_func(tab=tab, query=HistoryQuery(p=1, l=20))
+ assert resp[0] == expected
+ assert resp[1] == HTTPStatus.OK
+ if tab == "download":
+ mock_get_download_history.assert_called_once_with(HistoryQuery(q=None, p=1, l=20))
+ mock_get_upload_history.assert_not_called()
+ else:
+ mock_get_upload_history.assert_called_once_with(HistoryQuery(q=None, p=1, l=20))
+ mock_get_download_history.assert_not_called()
+
+
+def test_get_datebase_error(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.get)
+ with (
+ app.test_request_context(),
+ ):
+ exception_message = "download table connection error"
+ mock_get_download_history = mocker.patch(
+ "server.services.history.get_download_history_data",
+ side_effect=DatabaseError(""),
+ )
+ resp = test_func(tab="download", query=HistoryQuery(p=1, l=20))
+ assert resp[0] == ErrorResponse(code="", message=exception_message)
+ assert resp[1] == HTTPStatus.SERVICE_UNAVAILABLE
+ mock_get_download_history.assert_called_once_with(HistoryQuery(q=None, p=1, l=20))
+
+
+def test_public_status(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.public_status)
+ request_body = HistoryPublic(public=True)
+ history_id = "019c794e-0ac6-7380-8cbf-eac8175f9b21"
+ with app.test_request_context():
+ response = True
+ mock_update_public_status = mocker.patch(
+ "server.services.history.update_public_status",
+ return_value=response,
+ )
+ resp = test_func(tab="download", history_id=UUID(history_id), body=request_body)
+ assert resp[0] == HistoryPublic(public=response)
+ assert resp[1] == HTTPStatus.OK
+ mock_update_public_status.assert_called_once_with(
+ tab="download", history_id=UUID(history_id), public=request_body.public
+ )
+
+
+def test_public_status_record_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.public_status)
+ request_body = HistoryPublic(public=True)
+ history_id = "019c794e-b6a7-77eb-bad9-2d1f2a561222"
+ with app.test_request_context():
+ exception_message = f"{history_id} is not found"
+ mock_update_public_status = mocker.patch(
+ "server.services.history.update_public_status",
+ side_effect=RecordNotFound(exception_message),
+ )
+ resp = test_func(tab="download", history_id=UUID(history_id), body=request_body)
+ assert resp[0] == ErrorResponse(code="", message=exception_message)
+ assert resp[1] == HTTPStatus.NOT_FOUND
+ mock_update_public_status.assert_called_once_with(
+ tab="download", history_id=UUID(history_id), public=request_body.public
+ )
+
+
+def test_files(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.files)
+ file_id = "019c794e-0cae-7020-b297-16831f57b71b"
+ file_path = __file__
+ mock_send_file = mocker.patch("server.api.history.send_file", return_value="mocked response")
+ mock_get_file_path = mocker.patch("server.services.history.get_file_path", return_value=file_path)
+ with app.test_request_context():
+ resp = test_func(file_id=UUID(file_id))
+ assert resp == "mocked response"
+ mock_send_file.assert_called_once_with(path_or_file=Path(file_path))
+ mock_get_file_path.assert_called_once_with(UUID(file_id))
+
+
+def test_files_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.files)
+ file_id = "019c794e-b9af-7444-9474-123bcef06dfe"
+ file_path = "/non/existent/file/path"
+ mock_get_file_path = mocker.patch("server.services.history.get_file_path", return_value=file_path)
+ with app.test_request_context():
+ resp = test_func(file_id=UUID(file_id))
+ assert resp[0] == ErrorResponse(code="", message=f"File not found: {file_id}")
+ assert resp[1] == HTTPStatus.NOT_FOUND
+ mock_get_file_path.assert_called_once_with(UUID(file_id))
+
+
+def test_files_record_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.files)
+ file_id = "019c794e-b84f-76bf-91af-a07616a7abf1"
+ exception_message = f"{file_id} is not found"
+ mock_get_file_path = mocker.patch(
+ "server.services.history.get_file_path",
+ side_effect=RecordNotFound(exception_message),
+ )
+ with app.test_request_context():
+ resp = test_func(file_id=UUID(file_id))
+ assert resp[0] == ErrorResponse(code="", message=exception_message)
+ assert resp[1] == HTTPStatus.NOT_FOUND
+ mock_get_file_path.assert_called_once_with(UUID(file_id))
+
+
+@pytest.mark.parametrize(
+ ("file_path", "expected"),
+ [
+ (__file__, True),
+ ("/non/existent/file/path", False),
+ ],
+)
+def test_is_exist_files(app, mocker: MockerFixture, file_path, expected):
+ test_func = inspect.unwrap(history.is_exist_files)
+ file_id = "019c794e-bb17-758f-8f0b-63fc3c40a1d1"
+ mock_get_file_path = mocker.patch("server.services.history.get_file_path", return_value=file_path)
+ with app.test_request_context():
+ resp = test_func(file_id=UUID(file_id))
+ assert resp == (expected, HTTPStatus.OK)
+ mock_get_file_path.assert_called_once_with(UUID(file_id))
+
+
+def test_is_exist_files_record_not_found(app, mocker: MockerFixture):
+ test_func = inspect.unwrap(history.is_exist_files)
+ file_id = "019c794e-bc5e-75a4-a8a6-9e4fd32f62e9"
+ exception_message = f"{file_id} is not found"
+ mock_get_file_path = mocker.patch(
+ "server.services.history.get_file_path",
+ side_effect=RecordNotFound(exception_message),
+ )
+ with app.test_request_context():
+ resp = test_func(file_id=UUID(file_id))
+ assert resp[0] == ErrorResponse(code="", message=exception_message)
+ assert resp[1] == HTTPStatus.NOT_FOUND
+ mock_get_file_path.assert_called_once_with(UUID(file_id))
diff --git a/tests/unit/clients/test_bulks.py b/tests/unit/clients/test_bulks.py
new file mode 100644
index 00000000..d0b1f1f3
--- /dev/null
+++ b/tests/unit/clients/test_bulks.py
@@ -0,0 +1,101 @@
+import json
+import typing as t
+
+from datetime import UTC, datetime
+
+from pydantic import HttpUrl
+
+from server.clients import bulks
+from server.entities.bulk_request import BulkOperation, BulkResponse
+from server.entities.map_error import MapError
+from server.entities.map_group import Administrator, MapGroup, MemberUser, Meta, Service
+from tests.helpers import load_json_data
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+def test_post(app, mocker: MockerFixture):
+ operations = []
+ access_token = "test_access_token"
+ client_secret = "test_client"
+ mocker.patch("server.clients.bulks.get_time_stamp", return_value="1772175516")
+ mocker.patch(
+ "server.clients.bulks.compute_signature",
+ return_value="9f09ff6b8e31dec7c51662c2da90a5f95dc878a86f781ccb0205ed1649f2f22c",
+ )
+
+ mock_response = mocker.MagicMock()
+ mock_response.status_code = 200
+ mock_response.text = json.dumps(load_json_data("data/map_bulk.json"))
+ mocker.patch("server.clients.bulks.requests.post", return_value=mock_response)
+ put_group = MapGroup(
+ schemas=["urn:ietf:params:scim:schemas:mace:example.jp:core:2.0:Group"],
+ id="c8fdd6b4-35b6-41b8-959b-0e24b9a9700d",
+ display_name="JAIRO test group UPDATED",
+ public=False,
+ description="Created by John Doe",
+ member_list_visibility="Private",
+ meta=Meta(
+ created=datetime(2025, 8, 28, 2, 3, 40, tzinfo=UTC),
+ last_modified=datetime(2025, 8, 28, 2, 3, 40, tzinfo=UTC),
+ ),
+ members=[
+ MemberUser(
+ value="00404105-6f3e-47bb-b839-ad093153b34c",
+ display="John Doe",
+ ref=HttpUrl("https://sptest.cg.example.jp/api/v2/Users/00404105-6f3e-47bb-b839-ad093153b34c"),
+ )
+ ],
+ administrators=[
+ Administrator(
+ value="00404105-6f3e-47bb-b839-ad093153b34c",
+ display="John Doe",
+ ref=HttpUrl("https://sptest.cg.example.jp/api/v2/Users/00404105-6f3e-47bb-b839-ad093153b34c"),
+ )
+ ],
+ services=[
+ Service(
+ value="jairocloud-groups-manager",
+ display="JAIRO Cloud Groups Manager",
+ administrator_of_group=0,
+ ref=HttpUrl("https://sptest.cg.example.jp/api/v2/Services/jairocloud-groups-manager"),
+ )
+ ],
+ )
+ expected = BulkResponse(
+ operations=[
+ BulkOperation(
+ method="PUT",
+ path="Groups/c8fdd6b4-35b6-41b8-959b-0e24b9a9700d",
+ data=put_group,
+ response=put_group,
+ status="200",
+ ),
+ BulkOperation(method="DELETE", path="Users/00404105-6f3e-47bb-b839-ad093153b34c", status="204"),
+ ]
+ )
+ result = bulks.post(operations, access_token, client_secret)
+ assert isinstance(result, BulkResponse)
+ assert result == expected
+
+
+def test_post_return_map_error(app, mocker: MockerFixture):
+ operations = []
+ access_token = "test_access_token"
+ client_secret = "test_client"
+ mocker.patch("server.clients.bulks.get_time_stamp", return_value="1772175516")
+ mocker.patch(
+ "server.clients.bulks.compute_signature",
+ return_value="9f09ff6b8e31dec7c51662c2da90a5f95dc878a86f781ccb0205ed1649f2f22c",
+ )
+
+ mock_response = mocker.MagicMock()
+ mock_response.status_code = 500
+ mock_response.text = json.dumps(load_json_data("data/map_error.json"))
+ mocker.patch("server.clients.bulks.requests.post", return_value=mock_response)
+ expected = MapError.model_validate(load_json_data("data/map_error.json"))
+ result = bulks.post(operations, access_token, client_secret)
+ assert isinstance(result, MapError)
+ assert result == expected
diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py
index 46436b06..e2c9a28f 100644
--- a/tests/unit/conftest.py
+++ b/tests/unit/conftest.py
@@ -45,7 +45,6 @@ def test_config():
"entity_id": "https://test/shibboleth-sp",
"crt": "/test/server.crt",
"key": "/test/server.key",
- "connecter_id": "test_connecter_id",
},
"MAP_CORE": {
"base_url": "https://mapcore.test.jp",
@@ -59,26 +58,29 @@ def test_config():
"GROUPS": {
"id_patterns": {
"system_admin": "jc_roles_sysadm_test",
- "repository_admin": "jc_{repository_id}_roles_repoadm_test",
- "community_admin": "jc_{repository_id}_roles_comadm_test",
- "contributor": "jc_{repository_id}_roles_contributor_test",
- "general_user": "jc_{repository_id}_roles_generaluser_test",
- "user_defined": "jc_{repository_id}_groups_{user_defined_id}_test",
+ "repository_admin": "jc_{repository_id}_ro_radm_test",
+ "community_admin": "jc_{repository_id}_ro_cadm_test",
+ "contributor": "jc_{repository_id}_ro_cont_test",
+ "general_user": "jc_{repository_id}_ro_user_test",
+ "user_defined": "jc_{repository_id}_gr_{user_defined_id}_test",
},
"name_patterns": {
- "system_admin": "group_sysadm_{user_defined_id}_test",
- "repository_admin": "group_repoadm_{repository_name}_{user_defined_id}_test",
- "community_admin": "group_comadm_{repository_name}_{user_defined_id}_test",
- "contributor": "group_contributor_{repository_name}_{user_defined_id}_test",
- "general_user": "group_generaluser_{repository_name}_{user_defined_id}_test",
+ "system_admin": "ジャイロクラウドシステム管理者_テスト",
+ "repository_admin": "{repository_name}管理者_テスト",
+ "community_admin": "{repository_name}コミュニティ管理者_テスト",
+ "contributor": "{repository_name}投稿ユーザー_テスト",
+ "general_user": "{repository_name}一般ユーザー_テスト",
},
+ "max_id_length": "50 - len('jc_') - len('_gr_')",
},
"POSTGRES": {"db": "jctest", "host": db_host},
"REDIS": {
"cache_type": "RedisCache",
"single": {"base_url": f"redis://{redis_host}:6379/0"},
+ "key_prefix": "jcgroups-test",
},
"RABBITMQ": {"url": f"amqp://guest:guest@{amqp_host}:5672//"},
+ "STORAGE": {"local": {"temporary": "/var/tmp/jcgroups"}}, # noqa: S108
})
diff --git a/tests/unit/services/test_bulk.py b/tests/unit/services/test_bulk.py
new file mode 100644
index 00000000..6a78abe2
--- /dev/null
+++ b/tests/unit/services/test_bulk.py
@@ -0,0 +1,1214 @@
+import typing as t
+
+from datetime import UTC, datetime
+from pathlib import Path
+from uuid import UUID, uuid7
+
+import pytest
+
+from server.db.history import Files, _FileContent
+from server.entities.bulk import (
+ CheckResult,
+ HistorySummary,
+ RepositoryMember,
+ ResultSummary,
+ UserAggregated,
+ ValidateSummary,
+)
+from server.entities.bulk_request import BulkOperation, BulkResponse
+from server.entities.map_error import MapError
+from server.entities.map_group import MapGroup, MemberGroup, MemberUser
+from server.entities.map_user import EPPN, Email, Group, MapUser
+from server.entities.patch_request import AddOperation, RemoveOperation
+from server.entities.search_request import SearchResponse
+from server.entities.summaries import GroupSummary
+from server.entities.user_detail import UserDetail
+from server.exc import FileValidationError, OAuthTokenError, RecordNotFound, ResourceInvalid, ResourceNotFound
+from server.services import bulks
+from server.services.utils.affiliations import Affiliations, _Group
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+def assert_unordered_model_list_equal(list1, list2):
+ def to_tuple(x):
+ def deep_tuple(obj):
+ if isinstance(obj, dict):
+ return tuple(sorted((k, deep_tuple(v)) for k, v in obj.items()))
+ if isinstance(obj, list):
+ return tuple(deep_tuple(i) for i in obj)
+ return obj
+
+ return deep_tuple(x.dict())
+
+ assert set(map(to_tuple, list1)) == set(map(to_tuple, list2))
+
+
+def test_validate_upload_data(app, mocker: MockerFixture):
+ operator_id = "test_user_id"
+ operator_name = "test_user_name"
+ temp_file_id = uuid7()
+ file_path = "/var/tmp/test_file.csv" # noqa: S108
+ file_content = _FileContent(
+ repositories=[{"id": "repo1", "serviceName": "test_service"}],
+ groups=[{"id": "group1", "displayName": "Group 1"}, {"id": "group2", "displayName": "Group 2"}],
+ users=[{"id": "user1", "userName": "User 1"}, {"id": "user2", "userName": "User 2"}],
+ )
+ files = Files()
+ files.id = temp_file_id
+ files.file_path = file_path
+ files.file_content = file_content
+ mock_get_file_by_id = mocker.patch("server.services.history_table.get_file_by_id", return_value=files)
+ repository_member = RepositoryMember(groups={"group1", "group2"}, users={"user1", "user2"})
+ mock_get_repository_member = mocker.patch(
+ "server.services.bulks.get_repository_member", return_value=repository_member
+ )
+ mocker.patch("server.services.bulks.build_user_from_file", return_value=(None, None))
+ mocker.patch("server.services.bulks.build_user_detail_from_dict", return_value=mocker.MagicMock())
+ mocker.patch("server.services.bulks.build_user_detail_from_dict_by_name", return_value=mocker.MagicMock())
+ missing_users = [UserDetail(id="user3", user_name="User 3")]
+ mocker.patch("server.services.bulks._get_missing_users", return_value=missing_users)
+ mocker.patch("server.services.bulks._get_repo_user_by_id", return_value=None)
+ check_results = [
+ CheckResult(
+ id="user1",
+ eppn=["eppn1"],
+ email=["user1@example.com"],
+ user_name="User 1",
+ groups={"group1"},
+ status="update",
+ code=None,
+ ),
+ CheckResult(
+ id="user2",
+ eppn=["eppn2"],
+ email=["user2@example.com"],
+ user_name="User 2",
+ groups={"group2"},
+ status="skip",
+ code=None,
+ ),
+ CheckResult(
+ id="user3",
+ eppn=["eppn3"],
+ email=["user3@example.com"],
+ user_name="User 3",
+ groups={"group1", "group2"},
+ status="create",
+ code=None,
+ ),
+ ]
+ summary = HistorySummary(create=1, update=1, delete=0, skip=1, error=0)
+ mocker.patch(
+ "server.services.bulks._build_check_results",
+ return_value=(
+ check_results,
+ summary,
+ ),
+ )
+ mock_create_upload = mocker.patch(
+ "server.services.history_table.create_upload",
+ return_value=uuid7(),
+ )
+ validate_summary = ValidateSummary(
+ results=check_results, summary=summary, missing_user=missing_users, offset=0, page_size=3
+ )
+ result = bulks.validate_upload_data(operator_id, operator_name, temp_file_id)
+ assert isinstance(result, UUID)
+ mock_get_file_by_id.assert_called_once_with(temp_file_id)
+ mock_get_repository_member.assert_called_once_with("repo1")
+ mock_create_upload.assert_called_once_with(
+ operator_id=operator_id,
+ operator_name=operator_name,
+ file_id=temp_file_id,
+ results=validate_summary.model_dump(mode="json"),
+ )
+
+
+def test_get_repository_member(app, mocker: MockerFixture):
+ repository_id = "repo1"
+ groups = {"group1", "group2"}
+ users = {"user1", "user2"}
+ mock_search = mocker.patch(
+ "server.services.groups.search",
+ return_value=SearchResponse[MapGroup](
+ total_results=2,
+ start_index=1,
+ items_per_page=20,
+ resources=[
+ MapGroup(id="group1", display_name="Group 1", members=[MemberUser(value="user1", display="User 1")]),
+ MapGroup(
+ id="group2",
+ display_name="Group 2",
+ members=[
+ MemberUser(value="user2", display="User 2"),
+ MemberGroup(value="group1", display="Group 1"),
+ ],
+ ),
+ ],
+ ),
+ )
+ expected = RepositoryMember(groups=groups, users=users)
+ result = bulks.get_repository_member(repository_id)
+ mock_search.assert_called_once()
+ assert result == expected
+
+
+def test_build_user_from_file(app, mocker: MockerFixture):
+ header = [
+ "id",
+ "user_name",
+ "groups[].id",
+ "groups[].name",
+ "edu_person_principal_names[]",
+ "emails[]",
+ "preferred_language",
+ ]
+ meta = ["readonly", "readonly", "writable", "readonly", "readonly", "readonly", "readonly"]
+ data1 = ["user1", "User 1", "jc_repo1_gr_test_group1", "Group 1", "test@eppn", "user1@example.com", "en"]
+ data2 = ["user1", "User 1", "jc_repo1_gr_test_group2", "Group 2", "test@eppn", "user1@example.com", "en"]
+ data3 = ["", "User 2", "jc_repo1_gr_test_group1", "Group 1", "test@eppn", "user2@example.com", "ja"]
+ data4 = ["", "User 3", "jc_repo1_gr_test_group1", "Group 1", "test@eppn", "user2@example.com", "ja"]
+ data5 = []
+ data6 = ["", "", "jc_repo1_gr_test_group1", "Group 1", "test@eppn", "user2@example.com", "ja"]
+ rows = [iter([header, meta, data1, data2, data3, data4, data5, data6])]
+ mock_read_file = mocker.patch("server.services.bulks._read_file", return_value=iter(rows))
+ expected_data = {
+ "user1": {
+ "user_name": ["User 1", "User 1"],
+ "groups[].id": ["jc_repo1_gr_test_group1", "jc_repo1_gr_test_group2"],
+ "groups[].name": ["Group 1", "Group 2"],
+ "edu_person_principal_names[]": ["test@eppn", "test@eppn"],
+ "emails[]": ["user1@example.com", "user1@example.com"],
+ "preferred_language": ["en", "en"],
+ }
+ }
+ expected_new_data = {
+ "User 2": {
+ "id": [""],
+ "groups[].id": ["jc_repo1_gr_test_group1"],
+ "groups[].name": ["Group 1"],
+ "edu_person_principal_names[]": ["test@eppn"],
+ "emails[]": ["user2@example.com"],
+ "preferred_language": ["ja"],
+ },
+ "User 3": {
+ "id": [""],
+ "groups[].id": ["jc_repo1_gr_test_group1"],
+ "groups[].name": ["Group 1"],
+ "edu_person_principal_names[]": ["test@eppn"],
+ "emails[]": ["user2@example.com"],
+ "preferred_language": ["ja"],
+ },
+ }
+ dummy_file_path = "/var/tmp/test_file.csv" # noqa: S108
+ data, new_data = bulks.build_user_from_file(dummy_file_path)
+ mock_read_file.assert_called_once_with(dummy_file_path)
+ assert data == expected_data
+ assert new_data == expected_new_data
+
+
+def test_build_user_from_file_with_exception(app, mocker: MockerFixture):
+ dummy_file_path = "/var/tmp/test_file.css" # noqa: S108
+ expected_error_message = f"{Path(dummy_file_path).suffix}: Unsupported file format."
+ mock_read_file = mocker.patch(
+ "server.services.bulks._read_file",
+ side_effect=ResourceInvalid(expected_error_message),
+ )
+ with pytest.raises(ResourceNotFound) as exc:
+ bulks.build_user_from_file(dummy_file_path)
+ mock_read_file.assert_called_once_with(dummy_file_path)
+ assert str(exc.value) == expected_error_message
+
+
+@pytest.mark.parametrize(
+ ("file_path", "expected"),
+ [
+ ("/var/tmp/test_file.csv", [["id", "name"], ["1", "A"]]), # noqa: S108
+ ("/var/tmp/test_file.xlsx", [[1, "A"], [2, "B"]]), # noqa: S108
+ ],
+)
+def test__read_file(app, mocker: MockerFixture, file_path, expected):
+ mocker.patch("pathlib.Path.exists", return_value=True)
+ mocker.patch("pathlib.Path.open", mocker.mock_open(read_data="dummy"))
+ mocker.patch("csv.reader", return_value=iter(expected))
+ mock_ws = mocker.MagicMock()
+ mock_ws.iter_rows.return_value = iter(expected)
+ mock_wb = mocker.MagicMock()
+ mock_wb.active = mock_ws
+ mocker.patch("openpyxl.load_workbook", return_value=mock_wb)
+ result = bulks._read_file(file_path) # noqa: SLF001
+ assert list(next(result)) == expected
+
+
+def test__read_file_not_ws(app, mocker: MockerFixture):
+ file_path = "/var/tmp/test_file.xlsx" # noqa: S108
+ expected = [["id", "name"], ["1", "A"]]
+
+ mocker.patch("pathlib.Path.exists", return_value=True)
+ mocker.patch("pathlib.Path.open", mocker.mock_open(read_data="dummy"))
+ mock_ws = mocker.MagicMock()
+ mock_ws.iter_rows.return_value = iter(expected)
+ mock_wb = mocker.MagicMock()
+ mock_wb.active = None
+ mocker.patch("openpyxl.load_workbook", return_value=mock_wb)
+ with pytest.raises(ResourceInvalid) as exc: # noqa: PT012
+ result = bulks._read_file(file_path) # noqa: SLF001
+ next(result)
+ assert str(exc.value) == f"{file_path}: No active sheet found in the Excel file."
+
+
+@pytest.mark.parametrize(
+ ("file_path", "file_exist", "expected", "expected_exception"),
+ [
+ ("/var/tmp/test_file.csv", False, "/var/tmp/test_file.csv: File not found.", ResourceNotFound), # noqa: S108
+ ("/var/tmp/test_file.css", True, ".css: Unsupported file format.", ResourceInvalid), # noqa: S108
+ ],
+)
+def test__read_file_with_exception(app, mocker: MockerFixture, file_path, file_exist, expected, expected_exception):
+ mocker.patch("pathlib.Path.exists", return_value=file_exist)
+ with pytest.raises(expected_exception) as exc: # noqa: PT012
+ result = bulks._read_file(file_path) # noqa: SLF001
+ next(result)
+ assert str(exc.value) == expected
+
+
+def test_build_user_detail_from_dict(app, mocker: MockerFixture):
+ data = {
+ "user1": {
+ "user_name": ["User 1", "User 1"],
+ "groups[].id": ["jc_repo1_gr_test_group1", "jc_repo1_gr_test_group2", "jc_repo1_gr_test_group3"],
+ "groups[].name": ["Group 1", "Group 2"],
+ "edu_person_principal_names[]": ["test@eppn", "test@eppn"],
+ "emails[]": ["user1@example.com", "user1@example.com"],
+ "preferred_language": ["en", "en"],
+ },
+ "user2": {
+ "user_name": ["User 2", "User 2"],
+ "groups[].id": ["jc_repo1_gr_test_group1"],
+ "groups[].name": ["Group 1", "Group 2"],
+ "edu_person_principal_names[]": ["test@eppn", "test@eppn"],
+ "emails[]": ["user2@example.com", "user2@example.com"],
+ "preferred_language": ["ja", "ja"],
+ },
+ "": {
+ "user_name": [""],
+ "groups[].id": [""],
+ "groups[].name": [""],
+ "edu_person_principal_names[]": [""],
+ "emails[]": [""],
+ "preferred_language": [""],
+ },
+ }
+ expected = UserAggregated(
+ root=[
+ UserDetail(
+ id="user1",
+ user_name="User 1",
+ groups=[
+ GroupSummary(id="jc_repo1_gr_test_group1", display_name="Group 1"),
+ GroupSummary(id="jc_repo1_gr_test_group2", display_name="Group 2"),
+ GroupSummary(id="jc_repo1_gr_test_group3"),
+ ],
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ ),
+ UserDetail(
+ id="user2",
+ user_name="User 2",
+ groups=[
+ GroupSummary(id="jc_repo1_gr_test_group1", display_name="Group 1"),
+ ],
+ eppns=["test@eppn"],
+ emails=["user2@example.com"],
+ preferred_language="ja",
+ ),
+ ]
+ )
+ assert bulks.build_user_detail_from_dict(data) == expected
+
+
+def test_build_user_detail_from_dict_by_name(app, mocker: MockerFixture):
+ data = {
+ "User 2": {
+ "id": [""],
+ "groups[].id": ["jc_repo1_gr_test_group1"],
+ "groups[].name": ["Group 1"],
+ "edu_person_principal_names[]": ["test@eppn"],
+ "emails[]": ["user2@example.com"],
+ "preferred_language": ["ja"],
+ },
+ "User 3": {
+ "id": [""],
+ "groups[].id": ["jc_repo1_gr_test_group1"],
+ "groups[].name": ["Group 1", ""],
+ "edu_person_principal_names[]": ["test@eppn"],
+ "emails[]": ["user3@example.com"],
+ "preferred_language": ["ja"],
+ },
+ "": {
+ "id": [""],
+ "groups[].id": [""],
+ "groups[].name": [""],
+ "edu_person_principal_names[]": [""],
+ "emails[]": [""],
+ "preferred_language": [""],
+ },
+ }
+ expected = UserAggregated(
+ root=[
+ UserDetail(
+ user_name="User 2",
+ groups=[
+ GroupSummary(id="jc_repo1_gr_test_group1", display_name="Group 1"),
+ ],
+ eppns=["test@eppn"],
+ emails=["user2@example.com"],
+ preferred_language="ja",
+ ),
+ UserDetail(
+ user_name="User 3",
+ groups=[
+ GroupSummary(id="jc_repo1_gr_test_group1", display_name="Group 1"),
+ ],
+ preferred_language="ja",
+ eppns=["test@eppn"],
+ emails=["user3@example.com"],
+ ),
+ ]
+ )
+ assert bulks.build_user_detail_from_dict_by_name(data) == expected
+
+
+@pytest.mark.parametrize(
+ ("repository_member", "file_users_id", "expected"),
+ [
+ (RepositoryMember(groups={"group1", "group2"}, users={"user1", "user2"}), {"user1", "user2"}, []),
+ (
+ RepositoryMember(groups={"group1", "group2"}, users={"user1", "user2"}),
+ {"user2"},
+ [UserDetail(id="user1", user_name="User 1", eppns=["test@eppn"], emails=["user1@example.com"])],
+ ),
+ ],
+)
+def test__get_missing_users(app, mocker: MockerFixture, repository_member, file_users_id, expected):
+ mocker.patch(
+ "server.services.users.search",
+ return_value=SearchResponse[MapUser](
+ total_results=1,
+ start_index=0,
+ items_per_page=20,
+ resources=[
+ MapUser(
+ id="user1",
+ user_name="User 1",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="user1@example.com")],
+ )
+ ],
+ ),
+ )
+ result = bulks._get_missing_users(repository_member, file_users_id) # noqa: SLF001
+ assert result == expected
+
+
+@pytest.mark.parametrize(
+ ("repository_member", "file_users_id", "expected"),
+ [
+ (RepositoryMember(groups={"group1", "group2"}, users={"user1", "user2"}), {"user3"}, dict[str, UserDetail]()),
+ (
+ RepositoryMember(groups={"group1", "group2"}, users={"user1", "user2"}),
+ {"user1"},
+ {"user1": UserDetail(id="user1", user_name="User 1", eppns=["test@eppn"], emails=["user1@example.com"])},
+ ),
+ ],
+)
+def test__get_repo_user_by_id(app, mocker: MockerFixture, repository_member, file_users_id, expected):
+ mocker.patch(
+ "server.services.users.search",
+ return_value=SearchResponse[MapUser](
+ total_results=1,
+ start_index=0,
+ items_per_page=20,
+ resources=[
+ MapUser(
+ id="user1",
+ user_name="User 1",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="user1@example.com")],
+ )
+ ],
+ ),
+ )
+ result = bulks._get_repo_user_by_id(repository_member, file_users_id) # noqa: SLF001
+ assert result == expected
+
+
+def test__build_check_results(app, mocker: MockerFixture):
+ mocker.patch("server.services.bulks._check_immutable_attributes", return_value=None)
+ update_user = [
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ groups=[
+ GroupSummary(id="group1", display_name="Group 1"),
+ ],
+ ),
+ UserDetail(
+ id="user2",
+ user_name="User 2",
+ eppns=["test@eppn"],
+ emails=["user2@example.com"],
+ groups=[GroupSummary(id="group1", display_name="Group 1")],
+ ),
+ UserDetail(id="user3", user_name="User 1", eppns=["test@eppn"], emails=["user1@example.com"]),
+ UserDetail(id="not_repo_user", user_name="User 1", eppns=["test@eppn"], emails=["user1@example.com"]),
+ ]
+ create_user = [
+ UserDetail(
+ id="user4",
+ user_name="User 4",
+ eppns=["test@eppn"],
+ emails=["user4@example.com"],
+ groups=[
+ GroupSummary(id="group4", display_name="Group 4"),
+ ],
+ ),
+ UserDetail(user_name="User 5", eppns=["test@eppn"], emails=["user5@example.com"]),
+ UserDetail(id="user6", user_name="User 6", eppns=["test@eppn"], emails=["user6@example.com"]),
+ ]
+ repository_member = RepositoryMember(groups={"group1", "group2"}, users={"user1", "user2"})
+ repo_user_by_id = {
+ "user1": UserDetail(id="user1", user_name="User 1", eppns=["test@eppn"], emails=["user1@example.com"]),
+ "user2": UserDetail(
+ id="user2",
+ user_name="User 2",
+ eppns=["test@eppn"],
+ emails=["user2@example.com"],
+ groups=[GroupSummary(id="group2", display_name="Group 2")],
+ ),
+ "user3": UserDetail(id="user3", user_name="User 3", eppns=["test@eppn"], emails=["user3@example.com"]),
+ }
+ expected_check_results = [
+ CheckResult(
+ id="user4",
+ eppn=["test@eppn"],
+ email=["user4@example.com"],
+ user_name="User 4",
+ groups={"group4"},
+ status="error",
+ code="Group ID does not exist",
+ ),
+ CheckResult(
+ id=None,
+ eppn=["test@eppn"],
+ email=["user5@example.com"],
+ user_name="User 5",
+ groups=set(),
+ status="error",
+ code="Invalid user data",
+ ),
+ CheckResult(
+ id="user6",
+ eppn=["test@eppn"],
+ email=["user6@example.com"],
+ user_name="User 6",
+ groups=set(),
+ status="create",
+ code=None,
+ ),
+ CheckResult(
+ id="user2",
+ eppn=["test@eppn"],
+ email=["user2@example.com"],
+ user_name="User 2",
+ groups={"group1"},
+ status="update",
+ code=None,
+ ),
+ CheckResult(
+ id="user3",
+ eppn=["test@eppn"],
+ email=["user1@example.com"],
+ user_name="User 3",
+ groups=set(),
+ status="skip",
+ code=None,
+ ),
+ ]
+ expected_summary = HistorySummary(create=1, update=1, delete=0, skip=1, error=2)
+ result = bulks._build_check_results(update_user, create_user, repository_member, repo_user_by_id) # noqa: SLF001
+ assert result == (expected_check_results, expected_summary)
+
+
+@pytest.mark.parametrize(
+ ("user_detail", "expected"),
+ [
+ (
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ ),
+ False,
+ ),
+ (
+ UserDetail(
+ id="invalid@id",
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ ),
+ False,
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ ),
+ True,
+ ),
+ ],
+)
+def test__check_value(app, mocker: MockerFixture, user_detail, expected):
+ assert bulks._check_value(user_detail) == expected # noqa: SLF001
+
+
+@pytest.mark.parametrize(
+ ("original", "update_user", "expected"),
+ [
+ (
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group1", display_name="Group 1")],
+ ),
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group2", display_name="Group 2")],
+ ),
+ None,
+ ),
+ (
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group1", display_name="Group 1")],
+ ),
+ UserDetail(
+ user_name="User 2",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group2", display_name="Group 2")],
+ ),
+ "user_name is immutable",
+ ),
+ (
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group1", display_name="Group 1")],
+ ),
+ UserDetail(
+ user_name="User 1",
+ eppns=["test2@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group2", display_name="Group 2")],
+ ),
+ "eppns are immutable",
+ ),
+ (
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group1", display_name="Group 1")],
+ ),
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user2@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group2", display_name="Group 2")],
+ ),
+ "emails are immutable",
+ ),
+ (
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="en",
+ groups=[GroupSummary(id="group1", display_name="Group 1")],
+ ),
+ UserDetail(
+ user_name="User 1",
+ eppns=["test@eppn"],
+ emails=["user1@example.com"],
+ preferred_language="ja",
+ groups=[GroupSummary(id="group2", display_name="Group 2")],
+ ),
+ "preferred_language is immutable",
+ ),
+ ],
+)
+def test__check_immutable_attributes(app, mocker: MockerFixture, original, update_user, expected):
+ assert bulks._check_immutable_attributes(original, update_user) == expected # noqa: SLF001
+
+
+def test_get_validate_result(app, mocker: MockerFixture):
+ result = [
+ {
+ "id": "user1",
+ "eppn": ["test@eppn"],
+ "email": ["user1@example.com"],
+ "user_name": "User 1",
+ "groups": [],
+ "status": "create",
+ "code": None,
+ }
+ ]
+ mocker.patch("server.services.history_table.get_paginated_upload_results", return_value=result)
+ summary = HistorySummary(create=1, update=0, delete=0, skip=0, error=0)
+ missing_user = []
+ mocker.patch("server.services.history_table.get_upload_results", side_effect=[summary, missing_user])
+ repository_member = RepositoryMember(groups={"group1"}, users={"user1"})
+ mocker.patch("server.services.bulks.get_repository_member", return_value=repository_member)
+ history_id = uuid7()
+ status_filter = ["create"]
+ offset = 1
+ limit = 20
+ expected = ValidateSummary(
+ results=[
+ CheckResult(
+ id="user1",
+ eppn=["test@eppn"],
+ email=["user1@example.com"],
+ user_name="User 1",
+ groups=set(),
+ status="create",
+ code=None,
+ )
+ ],
+ summary=summary,
+ missing_user=missing_user,
+ offset=offset,
+ page_size=limit,
+ )
+ assert bulks.get_validate_result(history_id, status_filter, offset, limit) == expected
+
+
+def test_update_users_success(app, mocker):
+ history_id = uuid7()
+ temp_file_id = uuid7()
+ check_results = [
+ CheckResult(id="user1", eppn=[], email=[], user_name="User 1", groups=set(), status="create", code=None)
+ ]
+ summary = {"error": 0}
+ upload_data = mocker.MagicMock()
+ upload_data.file.file_content = {"repositories": [{"id": "repo1"}]}
+ upload_data.results = {"results": check_results, "summary": summary}
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=upload_data)
+ mocker.patch("server.services.bulks._build_bulk_operations_from_check_results", return_value=(["bulk_op"], 0))
+ mocker.patch("server.services.bulks.save_file", return_value="file_id")
+ mock_update_status = mocker.patch("server.services.history_table.update_upload_status")
+ mocker.patch("server.services.history_table.delete_file_by_id")
+ mocker.patch("server.services.bulks.get_access_token", return_value="token")
+ mocker.patch("server.services.bulks.get_client_secret", return_value="secret")
+ mocker.patch(
+ "server.services.bulks.bulks.post",
+ return_value=BulkResponse(operations=[BulkOperation(method="POST", path="/Users/user1", status="201")]),
+ )
+
+ result = bulks.update_users(history_id, temp_file_id, delete_users=None)
+
+ assert result == history_id
+ mock_update_status.assert_any_call(
+ history_id=history_id,
+ status="P",
+ file_id="file_id",
+ new_results={"results": check_results, "summary": {"error": 0, "delete": 0}},
+ )
+ mock_update_status.assert_any_call(
+ history_id=history_id,
+ status="S",
+ )
+
+
+def test_update_users_history_not_found(app, mocker):
+ history_id = uuid7()
+ temp_file_id = uuid7()
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=None)
+ with pytest.raises(ResourceNotFound) as exc:
+ bulks.update_users(history_id, temp_file_id, delete_users=None)
+ assert str(exc.value) == f"History not found: {history_id}"
+
+
+def test_update_users_error_in_summary(app, mocker):
+ history_id = uuid7()
+ temp_file_id = uuid7()
+ upload_data = mocker.MagicMock()
+ upload_data.file.file_content = {"repositories": [{"id": "repo1"}]}
+ upload_data.results = {"results": [], "summary": {"error": 1}}
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=upload_data)
+ with pytest.raises(FileValidationError) as exc:
+ bulks.update_users(history_id, temp_file_id, delete_users=None)
+ assert str(exc.value) == "There are errors in the validation results."
+
+
+def test_update_users_bulk_oauth_token_error(app, mocker):
+ history_id = uuid7()
+ temp_file_id = uuid7()
+ check_results = [
+ CheckResult(id="user1", eppn=[], email=[], user_name="User 1", groups=set(), status="create", code=None)
+ ]
+ summary = {"error": 0}
+ upload_data = mocker.MagicMock()
+ upload_data.file.file_content = {"repositories": [{"id": "repo1"}]}
+ upload_data.results = {"results": check_results, "summary": summary}
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=upload_data)
+ mocker.patch("server.services.bulks._build_bulk_operations_from_check_results", return_value=(["bulk_op"], 0))
+ mocker.patch("server.services.bulks.save_file", return_value="file_id")
+ mocker.patch("server.services.history_table.update_upload_status", return_value=None)
+ mocker.patch("server.services.history_table.delete_file_by_id")
+ expected_error_message = "OAuth tokens are not stored on the server."
+ mocker.patch("server.services.bulks.get_access_token", side_effect=OAuthTokenError(expected_error_message))
+ with pytest.raises(OAuthTokenError) as exc:
+ bulks.update_users(history_id, temp_file_id, delete_users=None)
+ assert str(exc.value) == expected_error_message
+
+
+def test_update_users_map_error(app, mocker):
+ history_id = uuid7()
+ temp_file_id = uuid7()
+ check_results = [
+ CheckResult(id="user1", eppn=[], email=[], user_name="User 1", groups=set(), status="create", code=None)
+ ]
+ summary = {"error": 0}
+ upload_data = mocker.MagicMock()
+ upload_data.file.file_content = {"repositories": [{"id": "repo1"}]}
+ upload_data.results = {"results": check_results, "summary": summary}
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=upload_data)
+ mocker.patch("server.services.bulks._build_bulk_operations_from_check_results", return_value=(["bulk_op"], 0))
+ mocker.patch("server.services.bulks.save_file", return_value="file_id")
+ mocker.patch("server.services.history_table.update_upload_status")
+ mocker.patch("server.services.history_table.delete_file_by_id")
+ mocker.patch("server.services.bulks.get_access_token", return_value="token")
+ mocker.patch("server.services.bulks.get_client_secret", return_value="secret")
+ mocker.patch(
+ "server.services.bulks.bulks.post",
+ return_value=MapError(status="400", scim_type="invalidValue", detail="error"),
+ )
+ with pytest.raises(ResourceInvalid):
+ bulks.update_users(history_id, temp_file_id, delete_users=None)
+
+
+def test_update_users_failed(app, mocker):
+ history_id = uuid7()
+ temp_file_id = uuid7()
+ check_results = [
+ CheckResult(id="user1", eppn=[], email=[], user_name="User 1", groups=set(), status="create", code=None),
+ CheckResult(id="user2", eppn=[], email=[], user_name="User 2", groups=set(), status="update", code=None),
+ ]
+ summary = {"error": 0}
+ upload_data = mocker.MagicMock()
+ upload_data.file.file_content = {"repositories": [{"id": "repo1"}]}
+ upload_data.results = {"results": check_results, "summary": summary}
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=upload_data)
+ mocker.patch("server.services.bulks._build_bulk_operations_from_check_results", return_value=(["bulk_op"], 0))
+ mocker.patch("server.services.bulks.save_file", return_value="file_id")
+ mocker.patch("server.services.history_table.update_upload_status")
+ mocker.patch("server.services.history_table.delete_file_by_id")
+ mocker.patch("server.services.bulks.get_access_token", return_value="token")
+ mocker.patch("server.services.bulks.get_client_secret", return_value="secret")
+ mocker.patch(
+ "server.services.bulks.bulks.post",
+ return_value=BulkResponse(
+ operations=[
+ BulkOperation(method="POST", path="/Users/user1", status="201"),
+ BulkOperation(method="POST", path="/Groups/group1", status="500"),
+ ]
+ ),
+ )
+
+ result = bulks.update_users(history_id, temp_file_id, delete_users=None)
+
+ assert result == history_id
+
+
+def test_save_file(app, mocker: MockerFixture):
+ file_content = _FileContent(
+ repositories=[{"id": "repo1", "serviceName": "test_service"}],
+ groups=[{"id": "group1", "displayName": "Group 1"}, {"id": "group2", "displayName": "Group 2"}],
+ users=[{"id": "user1", "userName": "User 1"}, {"id": "user2", "userName": "User 2"}],
+ )
+ file_path = "/var/tmp/jcgroups/test_file.csv" # noqa: S108
+ mock_get_file_by_id = mocker.patch(
+ "server.services.history_table.get_file_by_id",
+ return_value=mocker.MagicMock(file_content=file_content, file_path=file_path),
+ )
+ mocker.patch("pathlib.Path.exists", return_value=True)
+ mocker.patch("server.services.history_table.create_file", return_value=None)
+ mocker.patch("pathlib.Path.rename")
+ return_fnc = mocker.patch("server.services.history_table.create_file", return_value=None)
+ file_id = uuid7()
+ bulks.save_file(file_id)
+ mock_get_file_by_id.assert_called_once_with(file_id)
+ return_fnc.assert_called_once()
+
+
+def test_save_file_saved(app, mocker: MockerFixture):
+ file_content = _FileContent(
+ repositories=[{"id": "repo1", "serviceName": "test_service"}],
+ groups=[{"id": "group1", "displayName": "Group 1"}, {"id": "group2", "displayName": "Group 2"}],
+ users=[{"id": "user1", "userName": "User 1"}, {"id": "user2", "userName": "User 2"}],
+ )
+ mock_get_file_by_id = mocker.patch(
+ "server.services.history_table.get_file_by_id", return_value=mocker.MagicMock(file_content=file_content)
+ )
+ mocker.patch("server.services.history_table.create_file", return_value=None)
+ file_id = uuid7()
+ bulks.save_file(file_id)
+ mock_get_file_by_id.assert_called_once_with(file_id)
+
+
+def test_save_file_with_exception(app, mocker: MockerFixture):
+ file_id = uuid7()
+ file_content = _FileContent(
+ repositories=[{}],
+ groups=[{"id": "group1", "displayName": "Group 1"}, {"id": "group2", "displayName": "Group 2"}],
+ users=[{"id": "user1", "userName": "User 1"}, {"id": "user2", "userName": "User 2"}],
+ )
+ mocker.patch(
+ "server.services.history_table.get_file_by_id", return_value=mocker.MagicMock(file_content=file_content)
+ )
+ with pytest.raises(ResourceNotFound) as exc:
+ bulks.save_file(file_id)
+ assert str(exc.value) is not None
+
+
+def test_save_file_not_found(app, mocker: MockerFixture):
+ file_content = _FileContent(
+ repositories=[{"id": "repo1", "serviceName": "test_service"}],
+ groups=[{"id": "group1", "displayName": "Group 1"}, {"id": "group2", "displayName": "Group 2"}],
+ users=[{"id": "user1", "userName": "User 1"}, {"id": "user2", "userName": "User 2"}],
+ )
+ file_path = "/var/tmp/jcgroups/test_file.csv" # noqa: S108
+ mock_get_file_by_id = mocker.patch(
+ "server.services.history_table.get_file_by_id",
+ return_value=mocker.MagicMock(file_content=file_content, file_path=file_path),
+ )
+ mocker.patch("server.services.history_table.create_file", return_value=None)
+ file_id = uuid7()
+ with pytest.raises(ResourceNotFound) as exc:
+ bulks.save_file(file_id)
+ mock_get_file_by_id.assert_called_once_with(file_id)
+ assert str(exc.value) == f"File not found: {file_path}"
+
+
+def test_save_file_invalid_suffix(app, mocker: MockerFixture):
+ file_content = _FileContent(
+ repositories=[{"id": "repo1", "serviceName": "test_service"}],
+ groups=[{"id": "group1", "displayName": "Group 1"}, {"id": "group2", "displayName": "Group 2"}],
+ users=[{"id": "user1", "userName": "User 1"}, {"id": "user2", "userName": "User 2"}],
+ )
+ file_path = "/var/tmp/jcgroups/test_file.css" # noqa: S108
+ mock_get_file_by_id = mocker.patch(
+ "server.services.history_table.get_file_by_id",
+ return_value=mocker.MagicMock(file_content=file_content, file_path=file_path),
+ )
+ mocker.patch("pathlib.Path.exists", return_value=True)
+ mocker.patch("server.services.history_table.create_file", return_value=None)
+ file_id = uuid7()
+ with pytest.raises(ResourceInvalid) as exc:
+ bulks.save_file(file_id)
+ mock_get_file_by_id.assert_called_once_with(file_id)
+ assert str(exc.value) == "not supported file format."
+
+
+def test_build_map_user_from_check_result(app, mocker: MockerFixture):
+ check_result = CheckResult(
+ id="user1",
+ eppn=["test@eppn"],
+ email=["test@example.com"],
+ user_name="User 1",
+ groups={"group1", "group2"},
+ status="create",
+ code=None,
+ )
+ expected = MapUser(
+ id="user1",
+ user_name="User 1",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="test@example.com")],
+ groups=[Group(value="group1"), Group(value="group2")],
+ )
+ result = bulks.build_map_user_from_check_result(check_result)
+ assert result.id == expected.id
+ assert result.user_name == expected.user_name
+ assert_unordered_model_list_equal(result.edu_person_principal_names, expected.edu_person_principal_names)
+ assert_unordered_model_list_equal(result.emails, expected.emails)
+ assert_unordered_model_list_equal(result.groups, expected.groups)
+
+
+def test_build_remove_user_path(app, mocker: MockerFixture):
+ user = UserDetail(id="user1", user_name="User 1", eppns=["test@eppn"], emails=["test@example.com"])
+ repository_id = "repo1"
+ expected = BulkOperation(
+ method="PATCH",
+ bulk_id=None,
+ path="Users/user1",
+ data=RemoveOperation(path="groups[(value eq 'jc_repo1_gr_group1')]"),
+ location=None,
+ response=None,
+ status=None,
+ )
+ mocker.patch(
+ "server.services.utils.detect_affiliations",
+ return_value=Affiliations(
+ roles=[],
+ groups=[_Group(repository_id=repository_id, group_id="jc_repo1_gr_group1", user_defined_id="group1")],
+ ),
+ )
+ result = bulks.build_remove_user_path(user, repository_id)
+ assert result == expected
+
+
+def test__build_bulk_operations_from_check_results(app, mocker: MockerFixture):
+ repository_id = "repo1"
+ check_results = [
+ CheckResult(
+ id="user1",
+ eppn=["test@eppn"],
+ email=["test@example.com"],
+ user_name="User 1",
+ groups={"group1", "group2"},
+ status="create",
+ code=None,
+ ),
+ CheckResult(
+ id="user2",
+ eppn=["test@eppn"],
+ email=["test2@example.com"],
+ user_name="User 2",
+ groups={"group1", "group2"},
+ status="update",
+ code=None,
+ ),
+ CheckResult(
+ id="user3",
+ eppn=["test@eppn"],
+ email=["test3@example.com"],
+ user_name="User 3",
+ groups={"group1", "group2"},
+ status="update",
+ code=None,
+ ),
+ ]
+ delete_users = ["user1"]
+ expected = (
+ [
+ BulkOperation(
+ method="POST",
+ path="/Users",
+ data=MapUser(
+ id="user1",
+ user_name="User 1",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="test@example.com")],
+ groups=[Group(value="group2"), Group(value="group1")],
+ ),
+ ),
+ BulkOperation(
+ method="POST",
+ path="/Users",
+ data=MapUser(
+ id="user1",
+ user_name="User 1",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="test@example.com")],
+ groups=[Group(value="group2"), Group(value="group1")],
+ ),
+ ),
+ ],
+ 1,
+ )
+ mocker.patch(
+ "server.services.bulks.get_repository_member",
+ return_value=RepositoryMember(groups={"group1", "group2"}, users={"user1"}),
+ )
+ mocker.patch(
+ "server.services.bulks._get_repo_user_by_id",
+ return_value={
+ "user2": UserDetail(
+ id="user2",
+ user_name="User 2",
+ eppns=["test@eppn"],
+ emails=["test@example.com"],
+ groups=[GroupSummary(id="group3")],
+ ),
+ },
+ )
+ mocker.patch("server.services.bulks._build_groups_update_bulk_operations", return_value=[])
+ mocker.patch(
+ "server.services.users.search",
+ return_value=SearchResponse[MapUser](
+ total_results=0,
+ start_index=0,
+ items_per_page=20,
+ resources=[
+ MapUser(
+ id="user3",
+ user_name="User 3",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="test3@example.com")],
+ ),
+ MapUser(
+ user_name="User 4",
+ edu_person_principal_names=[EPPN(value="test@eppn")],
+ emails=[Email(value="test4@example.com")],
+ ),
+ ],
+ ),
+ )
+ mocker.patch(
+ "server.services.utils.detect_affiliations",
+ return_value=Affiliations(
+ roles=[],
+ groups=[_Group(repository_id=repository_id, group_id="jc_repo1_gr_group1", user_defined_id="group1")],
+ ),
+ )
+ result = bulks._build_bulk_operations_from_check_results(repository_id, check_results, delete_users) # noqa: SLF001
+ assert len(result[0]) == len(expected[0])
+ for r, e in zip(result[0], expected[0], strict=False):
+ assert r.method == e.method
+ assert r.path == e.path
+ assert isinstance(r.data, MapUser)
+ assert isinstance(e.data, MapUser)
+ assert r.data.id == e.data.id
+ assert r.data.user_name == e.data.user_name
+ assert_unordered_model_list_equal(r.data.edu_person_principal_names, e.data.edu_person_principal_names)
+ assert_unordered_model_list_equal(r.data.emails, e.data.emails)
+ assert_unordered_model_list_equal(r.data.groups, e.data.groups)
+ assert result[1] == expected[1]
+
+
+def test__build_groups_update_bulk_operations(app, mocker: MockerFixture):
+ mocker.patch("server.services.users.get_system_admins", return_value={"admin1"})
+ mocker.patch(
+ "server.services.groups.get_by_id",
+ return_value=MapGroup(
+ id="jc_repo1_gr_group1",
+ display_name="Group 1",
+ members=[MemberUser(value="user1"), MemberUser(value="user2"), MemberGroup(value="group1")],
+ ),
+ )
+ bulks._build_groups_update_bulk_operations({"group1": {"add": {"user1"}, "remove": {"user2", "user3"}}}) # noqa: SLF001
+
+
+def test__build_groups_update_bulk_operations_no_group(app, mocker: MockerFixture):
+ mocker.patch("server.services.users.get_system_admins", return_value={"admin1"})
+ mocker.patch("server.services.groups.get_by_id", side_effect=None)
+ result = bulks._build_groups_update_bulk_operations({"group1": {"add": set(), "remove": set()}}) # noqa: SLF001
+ assert result == [
+ BulkOperation(
+ method="PATCH",
+ path="Groups/group1",
+ data=AddOperation(op="add", path="members", value={"type": "User", "value": "admin1"}),
+ )
+ ]
+
+
+def test_get_upload_result(app, mocker: MockerFixture):
+ history_id = uuid7()
+ status_filter = ["create"]
+ offset = 0
+ size = 10
+ file_id = uuid7()
+ file_name = "test_file.csv"
+ operator = "test_operator"
+ start_timestamp = datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC)
+ items = [
+ CheckResult(
+ id="user1",
+ eppn=["test@eppn"],
+ email=["test@example.com"],
+ user_name="User 1",
+ groups={"group1"},
+ status="create",
+ code=None,
+ )
+ ]
+ mock_file = mocker.MagicMock(file_path="var/tmp/test_file.csv")
+ upload = mocker.MagicMock(
+ file_id=file_id, file=mock_file, operator_name=operator, timestamp=start_timestamp, end_timestamp=None
+ )
+ raw_results = [i.model_dump() for i in items]
+ summary = HistorySummary(create=1, update=1, delete=0, skip=0, error=0)
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=upload)
+ mocker.patch("server.services.history_table.get_paginated_upload_results", return_value=raw_results)
+ mocker.patch("server.services.history_table.get_upload_results", return_value=summary)
+
+ result = bulks.get_upload_result(history_id, status_filter, offset, size)
+
+ expected = ResultSummary(
+ items=items,
+ summary=summary,
+ file_id=file_id,
+ file_name=file_name,
+ operator=operator,
+ start_timestamp=start_timestamp,
+ total=0,
+ offset=offset,
+ page_size=size,
+ )
+ assert result == expected
+
+
+def test_get_upload_result_history_not_found(app, mocker: MockerFixture):
+ history_id = uuid7()
+ expected_error_message = f"upload history not found: {history_id}"
+ mocker.patch("server.services.history_table.get_upload_by_id", return_value=None)
+ with pytest.raises(RecordNotFound) as exc:
+ bulks.get_upload_result(history_id, status_filter=["create"], offset=1, size=20)
+ assert str(exc.value) == expected_error_message
+
+
+@pytest.mark.parametrize(
+ ("file_path", "file_exist"),
+ [
+ ("/var/tmp/test_file.csv", True), # noqa: S108
+ ("/var/tmp/test_file.csv", False), # noqa: S108
+ ],
+)
+def test_delete_temporary_file(app, mocker: MockerFixture, file_path, file_exist):
+ file_id = uuid7()
+ mocker.patch("server.services.history_table.get_file_by_id", return_value=mocker.MagicMock(file_path=file_path))
+ mocker.patch("pathlib.Path.exists", return_value=file_exist)
+ mocker.patch("pathlib.Path.unlink")
+ mocker.patch("server.services.history_table.delete_file_by_id")
+ bulks.delete_temporary_file(str(file_id))
+
+
+def test_delete_temporary_file_with_exception(app, mocker: MockerFixture):
+ file_id = uuid7()
+ mocker.patch("server.services.history_table.get_file_by_id", side_effect=RecordNotFound(""))
+ assert bulks.delete_temporary_file(str(file_id)) is None
diff --git a/tests/unit/services/test_history.py b/tests/unit/services/test_history.py
new file mode 100644
index 00000000..8f2daf5f
--- /dev/null
+++ b/tests/unit/services/test_history.py
@@ -0,0 +1,401 @@
+import typing as t
+
+from datetime import UTC, date, datetime
+from uuid import UUID
+
+import pytest
+
+from sqlalchemy.dialects import postgresql
+from sqlalchemy.exc import SQLAlchemyError
+
+from server.db.history import DownloadHistory, Files, UploadHistory, _FileContent, _ResultData
+from server.entities.history_detail import DownloadHistoryData, HistoryQuery, HistorySummary, UploadHistoryData
+from server.entities.search_request import SearchResult
+from server.entities.summaries import UserSummary
+from server.exc import DatabaseError, RecordNotFound
+from server.services import history
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+test_files_table_data = Files()
+test_files_table_data.id = UUID("019c794d-fb97-70f2-aba2-c3888973190d")
+test_files_table_data.file_path = "ver/tmp/2026/01/test_file.csv"
+test_files_table_data.file_content = _FileContent({
+ "users": [{"id": "user1", "userName": "user1_name"}, {"id": "user2", "userName": "user2_name"}],
+ "groups": [{"id": "group1", "displayName": "group1_name"}, {"id": "group2", "displayName": "group2_name"}],
+ "repositories": [{"id": "repo1", "serviceName": "repo1_name"}],
+})
+test_upload_history_table_data = UploadHistory()
+test_upload_history_table_data.id = UUID("019c794e-04c0-7403-8621-b04c40698107")
+test_upload_history_table_data.timestamp = datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC)
+test_upload_history_table_data.file_id = test_files_table_data.id
+test_upload_history_table_data.operator_id = "test_operator_id"
+test_upload_history_table_data.operator_name = "test_operator_name"
+test_upload_history_table_data.public = True
+test_upload_history_table_data.status = "P"
+test_upload_history_table_data.results = _ResultData({
+ "summary": {"skip": 0, "error": 0, "create": 0, "delete": 0, "update": 0},
+ "items": [
+ {
+ "id": "test_create_user_id",
+ "code": "",
+ "eppn": "test_create_user_eppn",
+ "email": "test_create_user_email",
+ "groups": "test_create_user_groups",
+ "status": "create",
+ "userName": "test_create_user_name",
+ }
+ ],
+ "missing_users": [
+ {
+ "id": "test_user_id",
+ "eppns": "test_user_eppn",
+ "emails": "test_user_emails",
+ "groups": "test_user_groups",
+ "created": "2024-06-01T00:00:00Z",
+ "userName": "test_user_name",
+ "lastModified": "2024-06-01T00:00:00Z",
+ "isSystemAdmin": False,
+ "repositoryRoles": "repository_admin",
+ "preferredLanguage": "ja",
+ }
+ ],
+})
+
+test_download_history_table_data = DownloadHistory()
+test_download_history_table_data.id = UUID("019c794e-08a7-7483-9888-5349a610d4a8")
+test_download_history_table_data.timestamp = datetime(2026, 1, 2, 0, 0, 0, tzinfo=UTC)
+test_download_history_table_data.file_id = test_files_table_data.id
+test_download_history_table_data.operator_id = "test_operator_id"
+test_download_history_table_data.operator_name = "test_operator_name"
+test_download_history_table_data.public = True
+test_download_history_table_data.parent_id = None
+
+
+@pytest.mark.parametrize(
+ ("criteria", "data_raw", "expected"),
+ [
+ (
+ HistoryQuery(d="asc"),
+ [],
+ SearchResult[UploadHistoryData](total=1, page_size=20, offset=0, resources=[]),
+ ),
+ (
+ HistoryQuery(d="desc"),
+ [(test_upload_history_table_data, test_files_table_data)],
+ SearchResult[UploadHistoryData](
+ total=1,
+ page_size=20,
+ offset=0,
+ resources=[
+ UploadHistoryData(
+ id=UUID("019c794e-04c0-7403-8621-b04c40698107"),
+ timestamp=datetime(2026, 1, 1, 0, 0, tzinfo=UTC),
+ end_timestamp=None,
+ public=True,
+ operator=UserSummary(
+ id="test_operator_id",
+ user_name="test_operator_name",
+ role=None,
+ emails=None,
+ eppns=None,
+ last_modified=None,
+ ),
+ status="P",
+ summary=HistorySummary(create=0, update=0, delete=0, skip=0, error=0),
+ file_path="ver/tmp/2026/01/test_file.csv",
+ file_id=UUID("019c794d-fb97-70f2-aba2-c3888973190d"),
+ repository_count=1,
+ group_count=2,
+ user_count=2,
+ )
+ ],
+ ),
+ ),
+ ],
+)
+def test_get_upload_history_data(app, mocker: MockerFixture, criteria, data_raw, expected):
+ mocker.patch("server.services.history._build_filters_for_history", return_value=[])
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.execute.return_value.scalar_one.return_value = 1
+ db.session.execute.return_value.all.return_value = data_raw
+ reslut = history.get_upload_history_data(criteria)
+ assert reslut.total == expected.total
+ assert reslut.page_size == expected.page_size
+ assert reslut.offset == expected.offset
+ assert reslut.resources == expected.resources
+
+
+@pytest.mark.parametrize(
+ ("criteria", "data_raw", "expected"),
+ [
+ (
+ HistoryQuery(d="asc"),
+ [],
+ SearchResult[DownloadHistoryData](total=1, page_size=20, offset=0, resources=[]),
+ ),
+ (
+ HistoryQuery(d="desc"),
+ [(test_download_history_table_data, test_files_table_data, 0)],
+ SearchResult[DownloadHistoryData](
+ total=1,
+ page_size=20,
+ offset=0,
+ resources=[
+ DownloadHistoryData(
+ id=UUID("019c794e-08a7-7483-9888-5349a610d4a8"),
+ timestamp=datetime(2026, 1, 2, 0, 0, tzinfo=UTC),
+ operator=UserSummary(
+ id="test_operator_id",
+ user_name="test_operator_name",
+ role=None,
+ emails=None,
+ eppns=None,
+ last_modified=None,
+ ),
+ public=True,
+ parent_id=None,
+ file_id=UUID("019c794d-fb97-70f2-aba2-c3888973190d"),
+ file_path="ver/tmp/2026/01/test_file.csv",
+ repository_count=1,
+ group_count=2,
+ user_count=2,
+ children_count=0,
+ )
+ ],
+ ),
+ ),
+ ],
+)
+def test_get_download_history_data(app, mocker: MockerFixture, criteria, data_raw, expected):
+ mocker.patch("server.services.history._build_filters_for_history", return_value=[])
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.execute.return_value.scalar_one.return_value = 1
+ db.session.execute.return_value.all.return_value = data_raw
+ reslut = history.get_download_history_data(criteria)
+ assert reslut.total == expected.total
+ assert reslut.page_size == expected.page_size
+ assert reslut.offset == expected.offset
+ assert reslut.resources == expected.resources
+
+
+@pytest.mark.parametrize(
+ ("is_system_admin", "criteria", "history_type", "expected_sqls", "expected_params"),
+ [
+ (
+ True,
+ HistoryQuery(
+ r=["repo1", "repo2"],
+ s=date(2026, 1, 1),
+ e=date(2026, 1, 31),
+ ),
+ "upload",
+ [
+ (
+ "(files.file_content[:file_content_1] @> CAST(:param_1 AS JSONB)) OR "
+ "(files.file_content[:file_content_2] @> CAST(:param_2 AS JSONB))"
+ ),
+ "upload_history.timestamp >= :timestamp_1",
+ "upload_history.timestamp < :timestamp_1",
+ ],
+ [
+ {
+ "file_content_1": "repositories",
+ "file_content_2": "repositories",
+ "param_1": [
+ {
+ "id": "repo1",
+ },
+ ],
+ "param_2": [
+ {
+ "id": "repo2",
+ },
+ ],
+ },
+ {"timestamp_1": date(2026, 1, 1)},
+ {"timestamp_1": date(2026, 2, 1)},
+ ],
+ ),
+ (
+ False,
+ HistoryQuery(g=["group1", "group2"], s=date(2026, 1, 1)),
+ "upload",
+ [
+ "upload_history.public IS true",
+ "files.file_content[:file_content_1] @> CAST(:param_1 AS JSONB)",
+ (
+ "(files.file_content[:file_content_1] @> CAST(:param_1 AS JSONB)) OR "
+ "(files.file_content[:file_content_2] @> CAST(:param_2 AS JSONB))"
+ ),
+ "upload_history.timestamp >= :timestamp_1",
+ "upload_history.timestamp < :timestamp_1",
+ ],
+ [
+ {},
+ {"file_content_1": "repositories", "param_1": [{"id": "repo1"}]},
+ {
+ "file_content_1": "groups",
+ "file_content_2": "groups",
+ "param_1": [
+ {
+ "id": "group1",
+ },
+ ],
+ "param_2": [
+ {
+ "id": "group2",
+ },
+ ],
+ },
+ {"timestamp_1": date(2026, 1, 1)},
+ {"timestamp_1": date(2026, 1, 2)},
+ ],
+ ),
+ (
+ False,
+ HistoryQuery(u=["user1", "user2"], e=date(2026, 1, 31)),
+ "download",
+ [
+ "download_history.public IS true",
+ "files.file_content[:file_content_1] @> CAST(:param_1 AS JSONB)",
+ (
+ "(files.file_content[:file_content_1] @> CAST(:param_1 AS JSONB)) OR "
+ "(files.file_content[:file_content_2] @> CAST(:param_2 AS JSONB))"
+ ),
+ "download_history.timestamp < :timestamp_1",
+ "download_history.parent_id IS NULL",
+ ],
+ [
+ {},
+ {"file_content_1": "repositories", "param_1": [{"id": "repo1"}]},
+ {
+ "file_content_1": "users",
+ "file_content_2": "users",
+ "param_1": [
+ {
+ "id": "user1",
+ },
+ ],
+ "param_2": [
+ {
+ "id": "user2",
+ },
+ ],
+ },
+ {"timestamp_1": date(2026, 2, 1)},
+ {},
+ ],
+ ),
+ (
+ False,
+ HistoryQuery(i="019c8d57-b463-7675-bcf3-aba9d8df6822", o=["operator1", "operator2"]),
+ "download",
+ [
+ "download_history.public IS true",
+ "files.file_content[:file_content_1] @> CAST(:param_1 AS JSONB)",
+ "download_history.operator_id IN (__[POSTCOMPILE_operator_id_1])",
+ "download_history.parent_id = :parent_id_1",
+ ],
+ [
+ {},
+ {"file_content_1": "repositories", "param_1": [{"id": "repo1"}]},
+ {"operator_id_1": ["operator1", "operator2"]},
+ {"parent_id_1": UUID("019c8d57-b463-7675-bcf3-aba9d8df6822")},
+ ],
+ ),
+ ],
+)
+def test__build_filters_for_history(
+ mocker: MockerFixture,
+ is_system_admin: bool, # noqa: FBT001
+ criteria: HistoryQuery,
+ history_type: t.Literal["upload", "download"],
+ expected_sqls,
+ expected_params,
+):
+ mocker.patch("server.services.history.is_current_user_system_admin", return_value=is_system_admin)
+ repoadmin_filter = mocker.patch("server.services.history.get_permitted_repository_ids", return_value={"repo1"})
+ filters = history._build_filters_for_history(criteria, history_type) # noqa: SLF001
+ assert len(filters) == len(expected_sqls) == len(expected_params)
+ for f, expected_sql, expected_param in zip(filters, expected_sqls, expected_params, strict=False):
+ assert str(f) == expected_sql
+ compiled = f.compile(dialect=postgresql.dialect()) # pyright: ignore[reportFunctionMemberAccess, reportAttributeAccessIssue]
+ assert compiled.params == expected_param
+
+ repoadmin_filter.assert_not_called() if is_system_admin else repoadmin_filter.assert_called_once()
+
+
+def test_update_public_status_not_found(app, mocker: MockerFixture):
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.get.return_value = None
+ with pytest.raises(RecordNotFound) as exc:
+ history.update_public_status(tab="upload", history_id=UUID("019c794e-04c0-7403-8621-b04c40698107"), public=True)
+ assert str(exc.value) == "019c794e-04c0-7403-8621-b04c40698107 is not found"
+
+
+def test_update_public_status_db_error(app, mocker: MockerFixture):
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.get.side_effect = SQLAlchemyError
+ with pytest.raises(DatabaseError) as exc:
+ history.update_public_status(tab="upload", history_id=UUID("019c794e-04c0-7403-8621-b04c40698107"), public=True)
+ assert str(exc.value) == "Failed to update the public status due to a database error."
+
+
+def test_update_public_status(app, mocker: MockerFixture):
+ expected = False
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.get.return_value = test_files_table_data
+ result = history.update_public_status(
+ tab="download", history_id=UUID("019c794e-04c0-7403-8621-b04c40698107"), public=expected
+ )
+ assert result == expected
+
+
+def test_get_file_path(app, mocker: MockerFixture):
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.get.return_value = test_files_table_data
+ result = history.get_file_path(UUID("019c794e-04c0-7403-8621-b04c40698107"))
+ assert result == test_files_table_data.file_path
+
+
+def test_get_file_path_not_found(app, mocker: MockerFixture):
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.get.return_value = None
+ with pytest.raises(RecordNotFound) as exc:
+ history.get_file_path(UUID("019c794e-04c0-7403-8621-b04c40698107"))
+ assert str(exc.value) == "File with ID 019c794e-04c0-7403-8621-b04c40698107 not found."
+
+
+def test_get_file_path_db_error(app, mocker: MockerFixture):
+ db = mocker.MagicMock()
+ mocker.patch("server.services.history.db", db)
+ db.session.get.side_effect = SQLAlchemyError
+ with pytest.raises(DatabaseError) as exc:
+ history.get_file_path(UUID("019c794e-04c0-7403-8621-b04c40698107"))
+ assert str(exc.value) == "Failed to retrieve the file path due to a database error."
+
+
+def test_empty_history_criteria():
+ criteria = history.empty_history_criteria()
+ assert hasattr(criteria, "i")
+ assert hasattr(criteria, "r")
+ assert hasattr(criteria, "g")
+ assert hasattr(criteria, "u")
+ assert hasattr(criteria, "o")
+ assert hasattr(criteria, "s")
+ assert hasattr(criteria, "e")
+ assert hasattr(criteria, "d")
+ assert hasattr(criteria, "p")
+ assert hasattr(criteria, "l")
+ for attr in vars(criteria):
+ assert getattr(criteria, attr) is None
diff --git a/tests/unit/services/test_history_table.py b/tests/unit/services/test_history_table.py
new file mode 100644
index 00000000..0f043215
--- /dev/null
+++ b/tests/unit/services/test_history_table.py
@@ -0,0 +1,242 @@
+import typing as t
+
+from uuid import uuid7
+
+import pytest
+
+from server.exc import InvalidQueryError, InvalidRecordError, RecordNotFound
+from server.services import history_table
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+def test_get_upload_by_id(app, mocker: MockerFixture):
+ history_id = uuid7()
+ result_fnc = mocker.patch("server.db.db.session.get", return_value=mocker.MagicMock())
+ history_table.get_upload_by_id(history_id)
+ result_fnc.assert_called_once()
+ assert result_fnc.call_args[0][1] == history_id
+
+
+def test_get_upload_results(app, mocker: MockerFixture):
+ history_id = uuid7()
+ attribute = "results"
+ result_fnc = mocker.patch(
+ "server.db.db.session.query",
+ return_value=mocker.MagicMock(filter=mocker.MagicMock(first=None)),
+ )
+ history_table.get_upload_results(history_id, attribute)
+ result_fnc.assert_called_once()
+
+
+@pytest.mark.parametrize(
+ ("status_filter"),
+ [(["S", "F"]), ([])],
+)
+def test_get_paginated_upload_results(app, mocker: MockerFixture, status_filter):
+ history_id = uuid7()
+ offset = 2
+ size = 10
+
+ mock_db = mocker.patch(
+ "server.db.db.session.query", return_value=mocker.MagicMock(filter=mocker.MagicMock(first=None))
+ )
+ history_table.get_paginated_upload_results(history_id, offset, size, status_filter)
+ mock_db.assert_called_once()
+
+
+def test_get_paginated_upload_results_with_exceptions(app, mocker: MockerFixture):
+ history_id = uuid7()
+ offset = 0
+ size = 10
+ status_filter = ["S", "F"]
+ with pytest.raises(InvalidQueryError) as exc:
+ history_table.get_paginated_upload_results(history_id, offset, size, status_filter)
+ assert str(exc.value) == "Invalid offset or size"
+
+
+def test_create_upload(app, mocker: MockerFixture):
+ file_id = uuid7()
+ results = {"summary": {"a": 1}, "results": [1, 2], "missing_users": ["x"]}
+ operator_id = "opid"
+ operator_name = "opname"
+ mock_add = mocker.patch("server.db.db.session.add")
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ mock_upload = mocker.patch("server.services.history_table.UploadHistory", autospec=True)
+ instance = mock_upload.return_value
+ instance.id = "dummy-id"
+ ret = history_table.create_upload(file_id, results, operator_id, operator_name)
+ mock_add.assert_called_once_with(instance)
+ mock_commit.assert_called_once()
+ assert ret == "dummy-id"
+
+
+def test_create_upload_not_summary(app):
+ file_id = uuid7()
+ results = {"results": [1, 2], "missing_users": ["x"]}
+ operator_id = "opid"
+ operator_name = "opname"
+ with pytest.raises(InvalidRecordError) as exc:
+ history_table.create_upload(file_id, results, operator_id, operator_name)
+ assert str(exc.value) == "Results must include 'summary' and 'results' keys"
+
+
+def test_update_upload_status(app, mocker: MockerFixture):
+ class Dummy:
+ pass
+
+ history_id = uuid7()
+ status = "S"
+ new_results = {"summary": {}, "results": [], "missing_users": []}
+ file_id = uuid7()
+ mock_get = mocker.patch("server.db.db.session.get")
+ obj = Dummy()
+ mock_get.return_value = obj
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ history_table.update_upload_status(history_id, status, new_results, file_id)
+ mock_get.assert_called_once_with(history_table.UploadHistory, history_id)
+ mock_commit.assert_called_once()
+ assert obj.status == status
+ assert obj.file_id == file_id
+ assert obj.results["summary"] == {}
+
+
+def test_update_upload_status_object_not_found(app, mocker: MockerFixture):
+ history_id = uuid7()
+ status = "S"
+ new_results = {"summary": {}, "results": [], "missing_users": []}
+ file_id = uuid7()
+ mock_get = mocker.patch("server.db.db.session.get", return_value=None)
+ history_table.update_upload_status(history_id, status, new_results, file_id)
+ mock_get.assert_called_once_with(history_table.UploadHistory, history_id)
+
+
+def test_update_upload_status_no_new_results(app, mocker: MockerFixture):
+ class Dummy:
+ pass
+
+ history_id = uuid7()
+ status = "P"
+ new_results = None
+ file_id = uuid7()
+ mock_get = mocker.patch("server.db.db.session.get")
+ obj = Dummy()
+ mock_get.return_value = obj
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ history_table.update_upload_status(history_id, status, new_results, file_id)
+ mock_get.assert_called_once_with(history_table.UploadHistory, history_id)
+ mock_commit.assert_called_once()
+ assert obj.status == status
+ assert obj.file_id == file_id
+
+
+def test_update_upload_status_no_file_id(app, mocker: MockerFixture):
+ class Dummy:
+ pass
+
+ history_id = uuid7()
+ status = "S"
+ new_results = None
+ file_id = None
+ mock_get = mocker.patch("server.db.db.session.get")
+ obj = Dummy()
+ mock_get.return_value = obj
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ history_table.update_upload_status(history_id, status, new_results, file_id)
+ mock_get.assert_called_once_with(history_table.UploadHistory, history_id)
+ mock_commit.assert_called_once()
+ assert obj.status == status
+
+
+def test_get_history_by_file_id(app, mocker: MockerFixture):
+ file_id = uuid7()
+ mock_query = mocker.MagicMock()
+ mock_filter_by = mocker.MagicMock()
+ mock_query.filter_by.return_value = mock_filter_by
+ mock_filter_by.one_or_none.return_value = "history_obj"
+ mocker.patch("server.db.db.session.query", return_value=mock_query)
+ ret = history_table.get_history_by_file_id(file_id)
+ mock_query.filter_by.assert_called_once_with(file_id=file_id)
+ mock_filter_by.one_or_none.assert_called_once()
+ assert ret == "history_obj"
+
+
+def test_get_history_by_file_id_not_found(app, mocker: MockerFixture):
+ file_id = uuid7()
+ mock_query = mocker.MagicMock()
+ mock_filter_by = mocker.MagicMock()
+ mock_query.filter_by.return_value = mock_filter_by
+ mock_filter_by.one_or_none.return_value = None
+ mocker.patch("server.db.db.session.query", return_value=mock_query)
+ with pytest.raises(RecordNotFound) as exc:
+ history_table.get_history_by_file_id(file_id)
+ assert str(exc.value) == f"History not found for file_id: {file_id}"
+
+
+def test_get_file_by_id(app, mocker):
+ file_id = uuid7()
+ mock_query = mocker.MagicMock()
+ mock_filter_by = mocker.MagicMock()
+ mock_query.filter_by.return_value = mock_filter_by
+ mock_filter_by.one_or_none.return_value = "file_obj"
+ mocker.patch("server.db.db.session.query", return_value=mock_query)
+ ret = history_table.get_file_by_id(file_id)
+ mock_query.filter_by.assert_called_once_with(id=file_id)
+ mock_filter_by.one_or_none.assert_called_once()
+ assert ret == "file_obj"
+
+
+def test_get_file_by_id_not_found(app, mocker):
+ file_id = uuid7()
+ mock_query = mocker.MagicMock()
+ mock_filter_by = mocker.MagicMock()
+ mock_query.filter_by.return_value = mock_filter_by
+ mock_filter_by.one_or_none.return_value = None
+ mocker.patch("server.db.db.session.query", return_value=mock_query)
+ with pytest.raises(RecordNotFound) as exc:
+ history_table.get_file_by_id(file_id)
+ assert str(exc.value) == f"File not found for file_id: {file_id}"
+
+
+def test_delete_file_by_id(app, mocker: MockerFixture):
+ file_id = uuid7()
+ mock_files = mocker.patch(
+ "server.services.history_table.Files",
+ return_value=mocker.MagicMock(query=mocker.MagicMock(filter=mocker.MagicMock(delete=mocker.MagicMock()))),
+ )
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ history_table.delete_file_by_id(file_id)
+ mock_files.query.filter.assert_called_once()
+ mock_commit.assert_called_once()
+
+
+def test_create_file(app, mocker: MockerFixture):
+ file_path = "/var/tmp/test_file.csv" # noqa: S108
+ file_content = {"repositories": [], "groups": [], "users": []}
+ file_id = uuid7()
+ mock_files = mocker.patch("server.services.history_table.Files", autospec=True)
+ instance = mock_files.return_value
+ instance.id = file_id
+ mock_add = mocker.patch("server.db.db.session.add")
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ ret = history_table.create_file(file_path, file_content, file_id)
+ mock_add.assert_called_once_with(instance)
+ mock_commit.assert_called_once()
+ assert ret == file_id
+
+
+def test_create_file_without_id(app, mocker: MockerFixture):
+ file_path = "/var/tmp/test_file.csv" # noqa: S108
+ file_content = {"repositories": [], "groups": [], "users": []}
+ file_id = None
+ mock_files = mocker.patch("server.services.history_table.Files", autospec=True)
+ instance = mock_files.return_value
+ instance.id = file_id
+ mock_add = mocker.patch("server.db.db.session.add")
+ mock_commit = mocker.patch("server.db.db.session.commit")
+ ret = history_table.create_file(file_path, file_content, file_id)
+ mock_add.assert_called_once_with(instance)
+ mock_commit.assert_called_once()
+ assert ret == file_id
diff --git a/tests/unit/services/test_permissions.py b/tests/unit/services/test_permissions.py
new file mode 100644
index 00000000..b05cfb09
--- /dev/null
+++ b/tests/unit/services/test_permissions.py
@@ -0,0 +1,224 @@
+import typing as t
+
+import pytest
+
+from flask_login import login_user
+
+from server.const import USER_ROLES
+from server.entities import map_error, map_group, map_service, map_user
+from server.entities.login_user import LoginUser
+from server.services.utils import permissions
+from server.services.utils.affiliations import Affiliations, _Group, _RoleGroup
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+test_sys_admin_user = LoginUser(
+ eppn="test_eppn",
+ is_member_of="https://cg.gakunin.jp/gr/group1;https://cg.gakunin.jp/gr/jc_roles_sysadm_test",
+ user_name="Test User",
+ map_id="test_user_id",
+ session_id="",
+)
+
+test_repo_admin_user = LoginUser(
+ eppn="test_eppn",
+ is_member_of="https://cg.gakunin.jp/gr/group1;https://cg.gakunin.jp/gr/jc_repo1_roles_repoadm_test;https://cg.gakunin.jp/gr/jc_repo2_roles_repoadm_test",
+ user_name="Test User",
+ map_id="test_user_id",
+ session_id="",
+)
+
+mock_affiliations = Affiliations(
+ roles=[
+ _RoleGroup(repository_id="repo1", role=USER_ROLES.REPOSITORY_ADMIN),
+ _RoleGroup(repository_id="repo2", role=USER_ROLES.REPOSITORY_ADMIN),
+ _RoleGroup(repository_id="repo3", role=USER_ROLES.CONTRIBUTOR),
+ ],
+ groups=[
+ _Group(repository_id="repo2", group_id="jc_repo2_groups_test_group2", user_defined_id="group2"),
+ _Group(repository_id="repo3", group_id="jc_repo3_groups_test_group3", user_defined_id="group3"),
+ ],
+)
+
+mock_affiliations_no_logged_in = Affiliations(roles=[], groups=[])
+
+mock_extract_group_ids = [
+ "jc_repo1_roles_repoadm",
+ "jc_repo1_groups_test_group1",
+ "jc_repo2_roles_repoadm",
+ "jc_repo3_roles_contributor",
+ "jc_repo4_groups_test_group2",
+]
+
+
+def test_extract_group_ids():
+ is_member_of = ";https://cg.gakunin.jp/sp/test_sp_AAA;https://cg.gakunin.jp/gr/group1/admin;https://cg.gakunin.jp/gr/group1;https://cg.gakunin.jp/gr/group2"
+ group_ids = permissions.extract_group_ids(is_member_of)
+ assert group_ids == ["group1", "group2"]
+
+
+def test_is_current_user_system_admin(app, mocker: MockerFixture):
+ mocker.patch(
+ "server.services.utils.permissions.extract_group_ids",
+ return_value=["group1", "jc_roles_sysadm_test"],
+ )
+ with app.test_request_context("/"):
+ login_user(test_sys_admin_user)
+ assert permissions.is_current_user_system_admin() is True
+
+
+def test_is_current_user_system_admin_not_logged_in(mocker: MockerFixture):
+ mocker.patch("server.services.utils.permissions.is_user_logged_in", return_value=False)
+ assert permissions.is_current_user_system_admin() is False
+
+
+def test_get_permitted_repository_ids(app, mocker: MockerFixture):
+ mocker.patch(
+ "server.services.utils.permissions.extract_group_ids",
+ return_value=["group1", "jc_roles_sysadm_test"],
+ )
+ mocker.patch(
+ "server.services.utils.permissions.extract_group_ids",
+ return_value=mock_extract_group_ids,
+ )
+ mocker.patch("server.services.utils.permissions.detect_affiliations", return_value=mock_affiliations)
+ with app.test_request_context("/"):
+ login_user(test_sys_admin_user)
+ permitted_ids = permissions.get_permitted_repository_ids()
+ assert permitted_ids == {"repo1", "repo2"}
+
+
+def test_get_permitted_repository_ids_not_logged_in(mocker: MockerFixture):
+ mocker.patch("server.services.utils.permissions.is_user_logged_in", return_value=False)
+ mocker.patch(
+ "server.services.utils.permissions.detect_affiliations",
+ return_value=mock_affiliations_no_logged_in,
+ )
+ permitted_ids = permissions.get_permitted_repository_ids()
+ assert permitted_ids == set()
+
+
+def test_filter_permitted_group_ids(mocker: MockerFixture):
+ mocker.patch("server.services.utils.permissions.get_permitted_repository_ids", return_value={"repo1", "repo2"})
+
+ mocker.patch(
+ "server.services.utils.permissions.detect_affiliations",
+ return_value=mock_affiliations,
+ )
+ permitted_group_ids = permissions.filter_permitted_group_ids(*mock_extract_group_ids)
+ assert permitted_group_ids == {"jc_repo2_groups_test_group2"}
+
+
+def test_get_current_user_affiliations(app, mocker: MockerFixture):
+ mocker.patch(
+ "server.services.utils.permissions.extract_group_ids",
+ return_value=["group1", "jc_roles_sysadm_test"],
+ )
+ mocker.patch("server.services.utils.permissions.detect_affiliations", return_value=mock_affiliations)
+ with app.test_request_context("/"):
+ login_user(test_sys_admin_user)
+ affiliations = permissions.get_current_user_affiliations()
+ assert affiliations == mock_affiliations
+
+
+def test_get_current_user_affiliations_not_logged_in(mocker: MockerFixture):
+ mocker.patch("server.services.utils.permissions.is_user_logged_in", return_value=False)
+ affiliations = permissions.get_current_user_affiliations()
+ assert affiliations == mock_affiliations_no_logged_in
+
+
+@pytest.mark.parametrize(
+ ("test_user", "expected_groups"),
+ [
+ (
+ test_sys_admin_user,
+ [
+ map_service.Group(value="jc_repo2_groups_test_group2"),
+ map_service.Group(value="jc_repo3_groups_test_group3"),
+ ],
+ ),
+ (
+ test_repo_admin_user,
+ [
+ map_service.Group(value="jc_repo2_groups_test_group2"),
+ ],
+ ),
+ ],
+)
+def test_remove_info_outside_system_map_service(app, mocker: MockerFixture, test_user, expected_groups):
+ entity = map_service.MapService(
+ id="service1",
+ groups=[
+ map_service.Group(value="jc_repo2_groups_test_group2"),
+ map_service.Group(value="external_group"),
+ map_service.Group(value="jc_repo3_groups_test_group3"),
+ ],
+ )
+ mocker.patch(
+ "server.services.utils.permissions.detect_affiliations",
+ return_value=mock_affiliations,
+ )
+ mocker.patch("server.services.utils.permissions.get_permitted_repository_ids", return_value={"repo1", "repo2"})
+ with app.test_request_context("/"):
+ login_user(test_user)
+ filtered_entity = permissions.remove_info_outside_system(entity)
+ assert isinstance(filtered_entity, map_service.MapService)
+ if filtered_entity.groups is None:
+ filtered_entity.groups = []
+ assert filtered_entity.groups == expected_groups
+
+
+@pytest.mark.parametrize(("test_user", "expected_member_count"), [(test_sys_admin_user, 2), (test_repo_admin_user, 1)])
+def test_remove_info_outside_system_map_group(app, mocker: MockerFixture, test_user, expected_member_count):
+ entity = map_group.MapGroup(
+ id="jc_repo1_groups_test_group1",
+ members=[
+ map_group.MemberGroup(value="jc_repo2_groups_test_group2"),
+ map_group.MemberGroup(value="jc_repo3_groups_test_group3"),
+ map_group.MemberGroup(value="external_group"),
+ ],
+ )
+ mocker.patch(
+ "server.services.utils.permissions.detect_affiliations",
+ return_value=mock_affiliations,
+ )
+ mocker.patch("server.services.utils.permissions.get_permitted_repository_ids", return_value={"repo1", "repo2"})
+ with app.test_request_context("/"):
+ login_user(test_user)
+ filtered_entity = permissions.remove_info_outside_system(entity)
+ assert isinstance(filtered_entity, map_group.MapGroup)
+ if filtered_entity.members is None:
+ filtered_entity.members = []
+ assert len(filtered_entity.members) == expected_member_count
+
+
+@pytest.mark.parametrize(("test_user", "expected_group_count"), [(test_sys_admin_user, 2), (test_repo_admin_user, 1)])
+def test_remove_info_outside_system_map_user(app, mocker: MockerFixture, test_user, expected_group_count):
+ entity = map_user.MapUser(
+ id="user1",
+ groups=[
+ map_user.Group(value="jc_repo2_groups_test_group2"),
+ map_user.Group(value="external_group"),
+ map_user.Group(value="jc_repo3_groups_test_group3"),
+ ],
+ )
+ mocker.patch(
+ "server.services.utils.permissions.detect_affiliations",
+ return_value=mock_affiliations,
+ )
+ mocker.patch("server.services.utils.permissions.get_permitted_repository_ids", return_value={"repo1", "repo2"})
+ with app.test_request_context("/"):
+ login_user(test_user)
+ filtered_entity = permissions.remove_info_outside_system(entity)
+ assert isinstance(filtered_entity, map_user.MapUser)
+ if filtered_entity.groups is None:
+ filtered_entity.groups = []
+ assert len(filtered_entity.groups) == expected_group_count
+
+
+def test_remove_info_outside_system_other_entity():
+ entity = map_error.MapError(status="404", scim_type="noTarget", detail="Not found")
+ filtered_entity = permissions.remove_info_outside_system(entity)
+ assert filtered_entity == entity
diff --git a/tests/unit/services/test_search_queries.py b/tests/unit/services/test_search_queries.py
new file mode 100644
index 00000000..ffd6547a
--- /dev/null
+++ b/tests/unit/services/test_search_queries.py
@@ -0,0 +1,590 @@
+import inspect
+import typing as t
+
+from datetime import date
+
+import pytest
+
+from pydantic import AliasGenerator, BaseModel, ConfigDict
+
+from server.api.schemas import GroupsQuery, RepositoriesQuery, UsersQuery
+from server.entities.search_request import SearchRequestParameter
+from server.exc import InvalidQueryError
+from server.services.utils import search_queries
+from server.services.utils.affiliations import Affiliations, _Group
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+@pytest.mark.parametrize(
+ ("search_query", "expected_function"),
+ [
+ (RepositoriesQuery(), "server.services.utils.search_queries.build_repositories_search_query"),
+ (GroupsQuery(), "server.services.utils.search_queries.build_groups_search_query"),
+ (UsersQuery(), "server.services.utils.search_queries.build_users_search_query"),
+ ],
+)
+def test_build_search_query(app, mocker: MockerFixture, search_query, expected_function):
+ mock_build_search_query = mocker.patch(expected_function, return_value="mocked_query")
+ assert search_queries.build_search_query(search_query) == "mocked_query"
+ mock_build_search_query.assert_called_once_with(search_query)
+
+
+def test_build_search_query_invalid_query(app, mocker: MockerFixture):
+ class DummyCriteria:
+ pass
+
+ with pytest.raises(InvalidQueryError) as exc:
+ search_queries.build_search_query(DummyCriteria()) # pyright: ignore[reportArgumentType]
+ assert str(exc.value) == f"Unsupported criteria type: {type(DummyCriteria())}"
+
+
+@pytest.mark.parametrize(
+ ("search_query", "is_system_admin", "permitted", "expected"),
+ [
+ (
+ RepositoriesQuery(q="test", i=["repo1"], k="id", d="asc", p=1, l=20),
+ True,
+ {"repo1", "repo2"},
+ SearchRequestParameter(
+ filter=(
+ '((serviceName co "test") or (serviceUrl co "test") or (entityIds.value co "test")) and '
+ '(groups.value eq "jc_roles_sysadm_test") and (id sw "jc_") and '
+ '(groups.value eq "jc_repo1_ro_radm_test")'
+ ),
+ start_index=1,
+ count=20,
+ sort_by="id",
+ sort_order="ascending",
+ ),
+ ),
+ (
+ RepositoriesQuery(q=None, i=["repo1"], k="entityIds", d="desc", p=None, l=20),
+ False,
+ {"repo1", "repo2"},
+ SearchRequestParameter(
+ filter='(groups.value eq "jc_roles_sysadm_test") and (groups.value eq "jc_repo1_ro_radm_test")',
+ start_index=None,
+ count=None,
+ sort_by="entityIds.value",
+ sort_order="descending",
+ ),
+ ),
+ (
+ RepositoriesQuery(q=None, i=["repo2"], k="invalid_key", d=None, p=1, l=None),
+ False,
+ {"repo1"},
+ SearchRequestParameter(
+ filter='(groups.value eq "jc_roles_sysadm_test") and (id eq "")',
+ start_index=1,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ RepositoriesQuery(q=None, i=["repo1"], k=None, d=None, p=None, l=None),
+ False,
+ set(),
+ SearchRequestParameter(
+ filter=(
+ '(groups.value eq "jc_roles_sysadm_test") and (id eq "") and '
+ '(groups.value eq "jc_repo1_ro_radm_test")'
+ ),
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ ],
+)
+def test_build_repositories_search_query(
+ app, mocker: MockerFixture, search_query, is_system_admin, permitted, expected
+):
+ mocker.patch("server.services.utils.search_queries.is_current_user_system_admin", return_value=is_system_admin)
+ mocker.patch("server.services.utils.search_queries.get_permitted_repository_ids", return_value=permitted)
+ assert search_queries.build_repositories_search_query(search_query) == expected
+
+
+@pytest.mark.parametrize(
+ ("search_query", "is_system_admin", "permitted", "affiliations", "expected"),
+ [
+ (
+ GroupsQuery(
+ q="test",
+ i=None,
+ r=None,
+ u=["test_user_id"],
+ s=0,
+ v=0,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ False,
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter=(
+ '((displayName co "test")) and (id eq "") and '
+ '(members.type eq "User" and members.value eq "test_user_id") and '
+ "(public eq true) and (memberListVisibility eq Public)"
+ ),
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ GroupsQuery(q=None, i=["jc_repo1_gr_test1"], r=None, u=None, s=1, v=1, k=None, d=None, p=None, l=None),
+ False,
+ {"repo1"},
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter='(id eq "jc_repo1_gr_test1") and (public eq false) and (memberListVisibility eq Private)',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ GroupsQuery(q=None, i=["jc_repo1_gr_test1"], r=None, u=None, s=None, v=2, k=None, d=None, p=None, l=None),
+ True,
+ {"repo1"},
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter='(id eq "jc_repo1_gr_test1") and (memberListVisibility eq Hidden)',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ GroupsQuery(q=None, i=None, r=None, u=None, s=None, v=None, k=None, d=None, p=None, l=None),
+ False,
+ {"repo1"},
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter='id sw "jc_repo1"', start_index=None, count=20, sort_by=None, sort_order=None
+ ),
+ ),
+ (
+ GroupsQuery(q=None, i=None, r=None, u=None, s=None, v=None, k=None, d=None, p=None, l=None),
+ True,
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(filter='id sw "jc_"', start_index=None, count=20, sort_by=None, sort_order=None),
+ ),
+ ],
+)
+def test_build_groups_search_query(
+ app, mocker: MockerFixture, search_query, is_system_admin, permitted, affiliations, expected
+):
+ mocker.patch("server.services.utils.search_queries.is_current_user_system_admin", return_value=is_system_admin)
+ mocker.patch("server.services.utils.search_queries.get_permitted_repository_ids", return_value=permitted)
+ mocker.patch("server.services.utils.search_queries.detect_affiliations", return_value=affiliations)
+ assert search_queries.build_groups_search_query(search_query) == expected
+
+
+def test_build_users_search_query_invalid_query(app, mocker: MockerFixture):
+ mocker.patch("server.services.utils.search_queries.is_current_user_system_admin", return_value=False)
+ mocker.patch("server.services.utils.search_queries.get_permitted_repository_ids", return_value={"repo1"})
+ mocker.patch(
+ "server.services.utils.search_queries.detect_affiliations", return_value=Affiliations(roles=[], groups=[])
+ )
+ with pytest.raises(InvalidQueryError) as exc:
+ search_queries.build_groups_search_query(GroupsQuery(i=["jc_repo1_gr_test1"]))
+ assert str(exc.value) == "Invalid group filter criteria"
+
+
+@pytest.mark.parametrize(
+ ("search_query", "permitted", "affiliations", "expected"),
+ [
+ (
+ UsersQuery(
+ q="test",
+ i=["test_user"],
+ r=["repo1"],
+ g=["jc_repo1_gr_test1"],
+ a=[0],
+ s=date(2026, 1, 1),
+ e=date(2026, 1, 31),
+ k="eppns",
+ d="asc",
+ p=None,
+ l=None,
+ ),
+ set(),
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter=(
+ '((userName co "test") or (emails.value co "test") or (eduPersonPrincipalNames.value co "test")) '
+ 'and (id eq "test_user") and (groups.value ne "jc_roles_sysadm_test" and '
+ '(groups.value eq "jc_repo1_gr_test1") and groups.value ne '
+ '"jc_roles_sysadm_test" and (groups.value eq "")) and (meta.lastModified ge '
+ '"2025-12-31T15:00:00+00:00") and (meta.lastModified lt "2026-01-31T15:00:00+00:00")'
+ ),
+ start_index=None,
+ count=20,
+ sort_by="eduPersonPrincipalNames.value",
+ sort_order="ascending",
+ ),
+ ),
+ (
+ UsersQuery(
+ q=None,
+ i=None,
+ r=None,
+ g=["jc_repo1_gr_test1"],
+ a=[1],
+ s=None,
+ e=None,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ set(),
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter=(
+ '(groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_gr_test1")) and '
+ '(groups.value ne "jc_roles_sysadm_test" and (groups.value sw "jc_" and '
+ 'groups.value ew "_ro_radm_test"))'
+ ),
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=["repo1"], g=None, a=[2], s=None, e=None, k=None, d=None, p=None, l=None),
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_ro_cadm_test")',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(
+ q=None,
+ i=None,
+ r=["repo2"],
+ g=["jc_repo1_gr_test1"],
+ a=None,
+ s=None,
+ e=None,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ set(),
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter='groups.value eq ""',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=["repo1"], g=None, a=None, s=None, e=None, k=None, d=None, p=None, l=None),
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value ne "jc_roles_sysadm_test" and (groups.value sw "jc_repo1")',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(
+ q=None,
+ i=None,
+ r=None,
+ g=["jc_repo1_gr_test1"],
+ a=None,
+ s=None,
+ e=None,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ set(),
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter='groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_gr_test1")',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=None, g=None, a=[0, 1, 3], s=None, e=None, k=None, d=None, p=None, l=None),
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter=(
+ '(groups.value eq "jc_roles_sysadm_test" or groups.value sw "jc_" and '
+ 'groups.value ew "_ro_radm_test" or groups.value sw "jc_" and '
+ 'groups.value ew "_ro_cont_test")'
+ ),
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=None, g=None, a=[5], s=None, e=None, k=None, d=None, p=None, l=None),
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value eq ""',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=None, g=None, a=None, s=None, e=None, k=None, d=None, p=None, l=None),
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value sw "jc_"',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ ],
+)
+def test_build_users_search_query_system_admin(
+ app, mocker: MockerFixture, search_query, permitted, affiliations, expected
+):
+ mocker.patch("server.services.utils.search_queries.is_current_user_system_admin", return_value=True)
+ mocker.patch("server.services.utils.search_queries.get_permitted_repository_ids", return_value=permitted)
+ mocker.patch("server.services.utils.search_queries.detect_affiliations", return_value=affiliations)
+ assert search_queries.build_users_search_query(search_query) == expected
+
+
+@pytest.mark.parametrize(
+ ("search_query", "permitted", "affiliations", "expected"),
+ [
+ (
+ UsersQuery(q=None, i=None, r=["repo1"], g=None, a=None, s=None, e=None, k=None, d=None, p=None, l=None),
+ set(),
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value eq ""',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=None, g=None, a=None, s=None, e=None, k=None, d=None, p=None, l=None),
+ {"repo1"},
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value ne "jc_roles_sysadm_test" and (groups.value sw "jc_repo1")',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(
+ q=None,
+ i=None,
+ r=None,
+ g=["jc_repo1_gr_test1"],
+ a=[1],
+ s=None,
+ e=None,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ {"repo1"},
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter=(
+ 'groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_gr_test1") '
+ 'and groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_ro_radm_test")'
+ ),
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(
+ q=None,
+ i=None,
+ r=None,
+ g=["jc_repo1_gr_test1"],
+ a=None,
+ s=None,
+ e=None,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ {"repo1"},
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter='groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_gr_test1")',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(q=None, i=None, r=None, g=None, a=[1], s=None, e=None, k=None, d=None, p=None, l=None),
+ {"repo1"},
+ Affiliations(roles=[], groups=[]),
+ SearchRequestParameter(
+ filter='groups.value ne "jc_roles_sysadm_test" and (groups.value eq "jc_repo1_ro_radm_test")',
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ (
+ UsersQuery(
+ q=None,
+ i=None,
+ r=None,
+ g=["jc_repo1_gr_test1"],
+ a=[0],
+ s=None,
+ e=None,
+ k=None,
+ d=None,
+ p=None,
+ l=None,
+ ),
+ {"repo1"},
+ Affiliations(
+ roles=[],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test1", user_defined_id="test1")],
+ ),
+ SearchRequestParameter(
+ filter=('groups.value eq ""'),
+ start_index=None,
+ count=20,
+ sort_by=None,
+ sort_order=None,
+ ),
+ ),
+ ],
+)
+def test_build_users_search_query_repo_admin(
+ app, mocker: MockerFixture, search_query, permitted, affiliations, expected
+):
+ mocker.patch("server.services.utils.search_queries.is_current_user_system_admin", return_value=False)
+ mocker.patch("server.services.utils.search_queries.get_permitted_repository_ids", return_value=permitted)
+ mocker.patch("server.services.utils.search_queries.detect_affiliations", return_value=affiliations)
+ assert search_queries.build_users_search_query(search_query) == expected
+
+
+@pytest.mark.parametrize(
+ ("resource_type", "kwargs", "expected"),
+ [
+ ("users", {"q": "test"}, search_queries.UsersCriteria),
+ ("groups", {"u": ["user1"], "v": 2}, search_queries.GroupsCriteria),
+ ("repositories", {}, search_queries.RepositoriesCriteria),
+ ("invalid_resource", {}, InvalidQueryError),
+ ],
+)
+def test_make_criteria_object(app, mocker: MockerFixture, resource_type, kwargs, expected):
+ if expected is InvalidQueryError:
+ with pytest.raises(InvalidQueryError):
+ search_queries.make_criteria_object(resource_type=resource_type, **kwargs)
+ else:
+ obj = search_queries.make_criteria_object(resource_type=resource_type, **kwargs)
+ assert isinstance(obj, expected)
+
+
+class DummyModel(BaseModel):
+ dummy_name: str
+
+
+class DummyModelWithAlias(BaseModel):
+ dummy_name: str
+ model_config = ConfigDict(alias_generator=AliasGenerator(serialization_alias=lambda x: x.upper()))
+
+
+@pytest.mark.parametrize(
+ ("model", "expected"),
+ [
+ (DummyModel, "dummy_name"),
+ (DummyModelWithAlias, "DUMMY_NAME"),
+ ],
+)
+def test__path_generator(app, mocker: MockerFixture, model, expected):
+ path = search_queries._path_generator(model) # noqa: SLF001
+ assert path("dummy_name") == expected
+
+
+def test__get_id_prefix_not_match(app, test_config, mocker: MockerFixture):
+ mocker.patch("server.config.config.REPOSITORIES.id_patterns.sp_connector", "invalid_pattern")
+ test_func = inspect.unwrap(search_queries._get_id_prefix) # noqa: SLF001
+ with pytest.raises(InvalidQueryError) as exc:
+ test_func()
+ assert str(exc.value) == "Invalid user-defined group ID pattern"
diff --git a/tests/unit/services/test_transformers.py b/tests/unit/services/test_transformers.py
new file mode 100644
index 00000000..d9247dbc
--- /dev/null
+++ b/tests/unit/services/test_transformers.py
@@ -0,0 +1,976 @@
+import typing as t
+
+from datetime import UTC, datetime
+
+import pytest
+
+from pydantic import HttpUrl
+
+from server.const import USER_ROLES
+from server.entities.group_detail import (
+ GroupDetail,
+ Repository as GroupRepository,
+ Service as GroupService_,
+)
+from server.entities.map_group import (
+ Administrator as GroupAdministrator,
+ MapGroup,
+ MemberUser,
+ Meta as GroupMeta,
+ Service as GroupService,
+)
+from server.entities.map_service import (
+ Administrator as ServiceAdministrator,
+ Group as MapServiceGroup,
+ MapService,
+ ServiceEntityID,
+)
+from server.entities.map_user import EPPN, Email, Group as UserGroup, MapUser, Meta as UserMeta
+from server.entities.repository_detail import RepositoryDetail
+from server.entities.search_request import SearchResult
+from server.entities.summaries import GroupSummary, RepositorySummary, UserSummary
+from server.entities.user_detail import RepositoryRole, UserDetail
+from server.exc import InvalidFormError, SystemAdminNotFound
+from server.services.utils import transformers
+from server.services.utils.affiliations import Affiliations, _Group, _RoleGroup
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+
+def assert_unordered_model_list_equal(list1, list2):
+ def to_tuple(x):
+ def deep_tuple(obj):
+ if isinstance(obj, dict):
+ return tuple(sorted((k, deep_tuple(v)) for k, v in obj.items()))
+ if isinstance(obj, list):
+ return tuple(deep_tuple(i) for i in obj)
+ return obj
+
+ return deep_tuple(x.dict())
+
+ assert set(map(to_tuple, list1)) == set(map(to_tuple, list2))
+
+
+def test_prepare_service(app, mocker: MockerFixture):
+ mock_return_value = MapService(
+ schemas=["urn:ietf:params:scim:schemas:mace:gakunin.jp:core:2.0:Service"],
+ id="jc_repo1_test",
+ service_name="service1",
+ service_url=HttpUrl("https://service1.example.com/"),
+ suspended=None,
+ meta=None,
+ entity_ids=[ServiceEntityID(value="https:///shibboleth-sp")],
+ administrators=None,
+ groups=None,
+ )
+ expected = MapService(
+ id="jc_repo1_test",
+ service_name="service1",
+ service_url=HttpUrl("https://service1.example.com/"),
+ suspended=None,
+ meta=None,
+ entity_ids=[ServiceEntityID(value="https:///shibboleth-sp")],
+ administrators=[
+ ServiceAdministrator(ref=None, display=None, value="admin1"),
+ ServiceAdministrator(ref=None, display=None, value="admin2"),
+ ],
+ groups=[
+ MapServiceGroup(ref=None, display=None, value="jc_roles_sysadm_test"),
+ MapServiceGroup(ref=None, display=None, value="jc_repo1_ro_radm_test"),
+ MapServiceGroup(ref=None, display=None, value="jc_repo1_ro_cadm_test"),
+ MapServiceGroup(ref=None, display=None, value="jc_repo1_ro_cont_test"),
+ MapServiceGroup(ref=None, display=None, value="jc_repo1_ro_user_test"),
+ ],
+ )
+ mocker.patch(
+ "server.services.utils.transformers.validate_repository_to_map_service", return_value=mock_return_value
+ )
+ expected_repository_id = "repo1"
+ mocker.patch("server.services.utils.transformers.resolve_repository_id", return_value=expected_repository_id)
+ administrators = {"admin1", "admin2"}
+ map_service, repository_id = transformers.prepare_service(RepositoryDetail(), administrators)
+ assert repository_id == expected_repository_id
+ assert map_service.id == expected.id
+ assert map_service.service_name == expected.service_name
+ assert map_service.service_url == expected.service_url
+ assert map_service.suspended == expected.suspended
+ assert map_service.meta == expected.meta
+ assert_unordered_model_list_equal(map_service.entity_ids, expected.entity_ids)
+ assert_unordered_model_list_equal(map_service.administrators, expected.administrators)
+ assert_unordered_model_list_equal(map_service.groups, expected.groups)
+
+
+def test_prepare_service_no_administrators(app, mocker: MockerFixture):
+ mock_return_value = MapService(
+ schemas=["urn:ietf:params:scim:schemas:mace:gakunin.jp:core:2.0:Service"],
+ id="jc_repo1_test",
+ service_name="service1",
+ service_url=HttpUrl("https://service1.example.com/"),
+ suspended=None,
+ meta=None,
+ entity_ids=[ServiceEntityID(value="https:///shibboleth-sp")],
+ administrators=None,
+ groups=None,
+ )
+ mocker.patch(
+ "server.services.utils.transformers.validate_repository_to_map_service", return_value=mock_return_value
+ )
+ administrators = set()
+ with pytest.raises(SystemAdminNotFound) as exc:
+ transformers.prepare_service(RepositoryDetail(), administrators)
+ assert str(exc.value) == "At least one administrator is required to create a repository."
+
+
+def test_prepare_role_groups(app, test_config, mocker: MockerFixture):
+ repository_id = "repo1"
+ service_id = "jc_repo1_test"
+ service_name = "service1"
+ administrators = {"admin1", "admin2"}
+ mocker.patch("server.services.utils.transformers.resolve_service_id", return_value=service_id)
+ expected_list = [
+ MapGroup(
+ id="jc_repo1_ro_radm_test",
+ display_name=f"{service_name}管理者_テスト",
+ public=False,
+ member_list_visibility="Private",
+ administrators=[GroupAdministrator(value="admin1"), GroupAdministrator(value="admin2")],
+ services=[GroupService(value=test_config.SP.connector_id), GroupService(value=service_id)],
+ ),
+ MapGroup(
+ id="jc_repo1_ro_cadm_test",
+ display_name=f"{service_name}コミュニティ管理者_テスト",
+ public=False,
+ member_list_visibility="Private",
+ administrators=[GroupAdministrator(value="admin1"), GroupAdministrator(value="admin2")],
+ services=[GroupService(value=test_config.SP.connector_id), GroupService(value=service_id)],
+ ),
+ MapGroup(
+ id="jc_repo1_ro_cont_test",
+ display_name=f"{service_name}投稿ユーザー_テスト",
+ public=False,
+ member_list_visibility="Private",
+ administrators=[GroupAdministrator(value="admin1"), GroupAdministrator(value="admin2")],
+ services=[GroupService(value=test_config.SP.connector_id), GroupService(value=service_id)],
+ ),
+ MapGroup(
+ id="jc_repo1_ro_user_test",
+ display_name=f"{service_name}一般ユーザー_テスト",
+ public=False,
+ member_list_visibility="Private",
+ administrators=[GroupAdministrator(value="admin1"), GroupAdministrator(value="admin2")],
+ services=[GroupService(value=test_config.SP.connector_id), GroupService(value=service_id)],
+ ),
+ ]
+ map_group_list = transformers.prepare_role_groups(repository_id, service_name, administrators)
+ assert len(map_group_list) == len(expected_list)
+ for map_group, expected in zip(map_group_list, expected_list, strict=False):
+ assert map_group.id == expected.id
+ assert map_group.external_id == expected.external_id
+ assert map_group.display_name == expected.display_name
+ assert map_group.public == expected.public
+ assert map_group.description == expected.description
+ assert map_group.suspended == expected.suspended
+ assert map_group.member_list_visibility == expected.member_list_visibility
+ assert map_group.meta == expected.meta
+ assert_unordered_model_list_equal(map_group.administrators, expected.administrators)
+ assert_unordered_model_list_equal(map_group.services, expected.services)
+
+
+def test_prepare_role_groups_no_administrators(app, mocker: MockerFixture):
+ repository_id = "repo1"
+ service_name = "service1"
+ administrators = set()
+ mocker.patch("server.services.utils.transformers.resolve_service_id", return_value="jc_repo1_test")
+ with pytest.raises(SystemAdminNotFound) as exc:
+ transformers.prepare_role_groups(repository_id, service_name, administrators)
+ assert str(exc.value) == "At least one administrator is required to create a repository."
+
+
+def test_make_repository_detail(app, mocker: MockerFixture):
+ repository_id = "repo1"
+ service = MapService(
+ schemas=["urn:ietf:params:scim:schemas:mace:gakunin.jp:core:2.0:Service"],
+ id="jc_repo1_test",
+ service_name="service1",
+ service_url=HttpUrl("https://service1.example.com/"),
+ suspended=True,
+ meta=None,
+ entity_ids=None,
+ administrators=None,
+ groups=[MapServiceGroup(value="jc_repo1_gr_test_group")],
+ )
+ expected = RepositoryDetail(
+ id=repository_id,
+ service_id=service.id,
+ service_name=service.service_name,
+ service_url=service.service_url,
+ active=not service.suspended,
+ entity_ids=None,
+ groups_count=1,
+ users_count=2,
+ created=None,
+ )
+ affiliation = _Group(repository_id=repository_id, group_id="jc_repo1_gr_test_group", user_defined_id="test_group")
+ mocker.patch("server.services.utils.transformers.resolve_repository_id", return_value=repository_id)
+ mocker.patch("server.services.utils.transformers.detect_affiliation", return_value=affiliation)
+ mocker.patch("server.services.users.count", return_value=2)
+ service_detail = transformers.make_repository_detail(service)
+ assert service_detail.id == expected.id
+ assert service_detail.service_id == expected.service_id
+ assert service_detail.service_name == expected.service_name
+ assert service_detail.service_url == expected.service_url
+ assert service_detail.active == expected.active
+ assert service_detail.entity_ids == expected.entity_ids
+
+
+def test_make_repository_detail_more(app, mocker: MockerFixture):
+ repository_id = "repo1"
+ entity_id = "https:///shibboleth-sp"
+ service = MapService(
+ schemas=["urn:ietf:params:scim:schemas:mace:gakunin.jp:core:2.0:Service"],
+ id="jc_repo1_test",
+ service_name="service1",
+ service_url=HttpUrl("https://service1.example.com/"),
+ suspended=True,
+ meta=None,
+ entity_ids=[ServiceEntityID(value=entity_id)],
+ administrators=[ServiceAdministrator(value="admin1"), ServiceAdministrator(value="admin2")],
+ groups=[MapServiceGroup(value="jc_repo1_gr_test_group")],
+ )
+ expected = RepositoryDetail(
+ id=repository_id,
+ service_id=service.id,
+ service_name=service.service_name,
+ service_url=service.service_url,
+ active=not service.suspended,
+ entity_ids=[entity_id],
+ groups_count=1,
+ users_count=2,
+ created=None,
+ )
+ expected._groups = ["jc_repo1_gr_test_group"] # noqa: SLF001
+ expected._rolegroups = [] # noqa: SLF001
+ expected._admins = ["admin1", "admin2"] # noqa: SLF001
+ affiliation = _Group(repository_id=repository_id, group_id="jc_repo1_gr_test_group", user_defined_id="test_group")
+ mocker.patch("server.services.utils.transformers.resolve_repository_id", return_value=repository_id)
+ mocker.patch("server.services.utils.transformers.detect_affiliation", return_value=affiliation)
+ mocker.patch("server.services.users.count", return_value=2)
+ service_detail = transformers.make_repository_detail(service, more_detail=True)
+ assert service_detail == expected
+ assert service_detail.id == expected.id
+ assert service_detail.service_id == expected.service_id
+ assert service_detail.service_name == expected.service_name
+ assert service_detail.service_url == expected.service_url
+ assert service_detail.active == expected.active
+ assert service_detail.entity_ids == expected.entity_ids
+ assert service_detail.groups_count == expected.groups_count
+ assert service_detail.users_count == expected.users_count
+ assert service_detail.created == expected.created
+
+
+@pytest.mark.parametrize(
+ ("repository", "expected", "expected_exception"),
+ [
+ (
+ RepositoryDetail(
+ id="test",
+ service_name="test",
+ service_url=HttpUrl("https://FQDN/example.com/"),
+ entity_ids=["https:///shibboleth-sp"],
+ ),
+ MapService(id="test"),
+ None,
+ ),
+ (
+ RepositoryDetail(
+ id="test",
+ service_name=None,
+ service_url=HttpUrl("https://FQDN/example.com/"),
+ entity_ids=["https:///shibboleth-sp"],
+ ),
+ "Service name is required to create a repository.",
+ InvalidFormError,
+ ),
+ (
+ RepositoryDetail(
+ id="test", service_name="test", entity_ids=["https:///shibboleth-sp"], service_url=None
+ ),
+ "Service URL is required to create a repository.",
+ InvalidFormError,
+ ),
+ (
+ RepositoryDetail(
+ id=None,
+ service_name="test",
+ service_url=HttpUrl("https://FQDN/example.com/"),
+ entity_ids=["https:///shibboleth-sp"],
+ ),
+ "Service URL must contain a valid host.",
+ InvalidFormError,
+ ),
+ (
+ RepositoryDetail(
+ id="test",
+ service_name="test",
+ service_url=HttpUrl("https://example.com/very/very/very/very/very/very/very/long/url"),
+ entity_ids=["https:///shibboleth-sp"],
+ ),
+ "Service URL is too long.",
+ InvalidFormError,
+ ),
+ (
+ RepositoryDetail(
+ id="test", service_name="test", service_url=HttpUrl("https://FQDN/example.com/"), entity_ids=[]
+ ),
+ "At least one entity ID is required to create a repository.",
+ InvalidFormError,
+ ),
+ ],
+)
+def test_validate_repository_to_map_service(app, mocker: MockerFixture, repository, expected, expected_exception):
+ repository_id = repository.id
+ service_id = "jc_repo1_test"
+ mocker.patch("server.services.utils.transformers.resolve_repository_id", return_value=repository_id)
+ mocker.patch("server.services.utils.transformers.resolve_service_id", return_value=service_id)
+ expected_return = mocker.patch("server.services.utils.transformers.make_map_service", return_value=expected)
+ if expected_exception:
+ with pytest.raises(expected_exception) as exc:
+ transformers.validate_repository_to_map_service(repository)
+ assert str(exc.value) == expected
+ else:
+ transformers.validate_repository_to_map_service(repository)
+ repository.service_id = service_id
+ expected_return.assert_called_once_with(repository)
+
+
+@pytest.mark.parametrize(
+ ("repository", "expected"),
+ [
+ (
+ RepositoryDetail(service_id="jc_repo1_test", active=True, entity_ids=["https:///shibboleth-sp"]),
+ MapService(
+ id="jc_repo1_test", suspended=False, entity_ids=[ServiceEntityID(value="https:///shibboleth-sp")]
+ ),
+ ),
+ (
+ RepositoryDetail(service_id="jc_repo1_test", active=None, entity_ids=None),
+ MapService(id="jc_repo1_test", suspended=None, entity_ids=None),
+ ),
+ ],
+)
+def test_make_map_service(app, mocker: MockerFixture, repository, expected):
+ assert transformers.make_map_service(repository) == expected
+
+
+def test_prepare_group(app, test_config, mocker: MockerFixture):
+ detail = GroupDetail(type="group")
+ administrators = {"admin1", "admin2"}
+ repository_id = "repo1"
+ service_id = "jc_repo1_test"
+ expected = MapGroup()
+ mocker.patch(
+ "server.services.utils.transformers.validate_group_to_map_group", return_value=(expected, repository_id)
+ )
+ expected.administrators = [GroupAdministrator(value=user_id) for user_id in administrators]
+ expected.services = [GroupService(value=test_config.SP.connector_id), GroupService(value=service_id)]
+ mocker.patch("server.services.utils.transformers.resolve_service_id", return_value=service_id)
+ map_group = transformers.prepare_group(detail, administrators)
+ assert_unordered_model_list_equal(map_group.administrators, expected.administrators)
+ assert_unordered_model_list_equal(map_group.services, expected.services)
+
+
+def test_prepare_group_no_administrators(app, mocker: MockerFixture):
+ detail = GroupDetail(type="group")
+ administrators = set()
+ expected = "At least one administrator is required to create a repository."
+ mocker.patch("server.services.utils.transformers.validate_group_to_map_group", return_value=(MapGroup(), "repo1"))
+ with pytest.raises(SystemAdminNotFound) as exc:
+ transformers.prepare_group(detail, administrators)
+ assert str(exc.value) == expected
+
+
+def test_make_group_detail(app, mocker: MockerFixture):
+ group = MapGroup(
+ id="jc_repo1_gr_test_group",
+ display_name="Test Group",
+ public=True,
+ meta=GroupMeta(
+ created=datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC), last_modified=datetime(2026, 1, 2, 0, 0, 0, tzinfo=UTC)
+ ),
+ members=[MemberUser(value="user1"), MemberUser(value="user2")],
+ administrators=[GroupAdministrator(value="admin1"), GroupAdministrator(value="admin2")],
+ services=[GroupService(value="jc_repo1_test")],
+ )
+ expected = GroupDetail(
+ id="jc_repo1_gr_test_group",
+ display_name="Test Group",
+ public=True,
+ users_count=2,
+ type=None,
+ created=datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC),
+ last_modified=datetime(2026, 1, 2, 0, 0, 0, tzinfo=UTC),
+ )
+ expected._users = [UserSummary(id="user1"), UserSummary(id="user2")] # noqa: SLF001
+ expected._admins = [UserSummary(id="admin1"), UserSummary(id="admin2")] # noqa: SLF001
+ expected._services = [GroupService_(id="jc_repo1_test")] # noqa: SLF001
+ group_detail = transformers.make_group_detail(group)
+ assert group_detail == expected
+
+
+@pytest.mark.parametrize(
+ ("group", "affiliation", "repository_detail", "expected"),
+ [
+ (
+ MapGroup(id="jc_repo1_gr_test_group", display_name="Test Group", public=True),
+ None,
+ None,
+ GroupDetail(
+ id="jc_repo1_gr_test_group",
+ user_defined_id=None,
+ display_name="Test Group",
+ public=True,
+ type=None,
+ ),
+ ),
+ (
+ MapGroup(id="jc_repo1_gr_test_group", display_name="Test Group", public=True),
+ _Group(repository_id="repo1", group_id="jc_repo1_gr_test_group", user_defined_id="test_group"),
+ None,
+ GroupDetail(
+ id="jc_repo1_gr_test_group",
+ display_name="Test Group",
+ public=True,
+ users_count=None,
+ type="group",
+ user_defined_id="test_group",
+ repository=None,
+ ),
+ ),
+ (
+ MapGroup(id="jc_repo1_gr_test_group", display_name="Test Group", public=True),
+ _Group(repository_id="repo1", group_id="jc_repo1_gr_test_group", user_defined_id="test_group"),
+ RepositoryDetail(service_name="service1"),
+ GroupDetail(
+ id="jc_repo1_gr_test_group",
+ display_name="Test Group",
+ public=True,
+ users_count=None,
+ type="group",
+ user_defined_id="test_group",
+ repository=GroupRepository(id="repo1", service_name="service1"),
+ ),
+ ),
+ ],
+)
+def test_make_group_detail_more(app, mocker: MockerFixture, group, affiliation, repository_detail, expected):
+ mocker.patch(
+ "server.services.utils.transformers.detect_affiliation",
+ return_value=affiliation,
+ )
+ mocker.patch("server.services.repositories.get_by_id", return_value=repository_detail)
+ group_detail = transformers.make_group_detail(group, more_detail=True)
+ assert group_detail == expected
+
+
+@pytest.mark.parametrize(
+ ("group", "mode", "expected", "expectedarg"),
+ [
+ (
+ GroupDetail(display_name="Test Group", id="jc_repo1_gr_test_group", type="group"),
+ "update",
+ MapGroup(),
+ GroupDetail(display_name="Test Group", id="jc_repo1_gr_test_group", type="group"),
+ ),
+ (
+ GroupDetail(
+ display_name="Test Group",
+ repository=GroupRepository(id="repo1"),
+ user_defined_id="test_group",
+ public=None,
+ member_list_visibility=None,
+ type="group",
+ ),
+ "create",
+ (MapGroup(), "repo1"),
+ GroupDetail(
+ id="jc_repo1_gr_test_group_test",
+ display_name="Test Group",
+ repository=GroupRepository(id="repo1"),
+ user_defined_id="test_group",
+ public=False,
+ member_list_visibility="Private",
+ type="group",
+ ),
+ ),
+ (
+ GroupDetail(
+ display_name="Test Group",
+ repository=GroupRepository(id="repo1"),
+ user_defined_id="test_group",
+ public=True,
+ member_list_visibility="Hidden",
+ type="group",
+ ),
+ "create",
+ (MapGroup(), "repo1"),
+ GroupDetail(
+ id="jc_repo1_gr_test_group_test",
+ display_name="Test Group",
+ repository=GroupRepository(id="repo1"),
+ user_defined_id="test_group",
+ public=True,
+ member_list_visibility="Hidden",
+ type="group",
+ ),
+ ),
+ ],
+)
+def test_validate_group_to_map_group(app, mocker: MockerFixture, group, mode, expected, expectedarg):
+ mocker.patch("server.services.repositories.get_by_id", return_value=RepositoryDetail(id="repo1"))
+ mock_make_map_group = mocker.patch("server.services.utils.transformers.make_map_group", return_value=MapGroup())
+ assert transformers.validate_group_to_map_group(group=group, mode=mode) == expected
+ mock_make_map_group.assert_called_once_with(expectedarg)
+
+
+@pytest.mark.parametrize(
+ ("group", "mode", "repository_exist", "expected"),
+ [
+ (GroupDetail(display_name=None, type="group"), "create", False, "Display name is required to create a group."),
+ (
+ GroupDetail(display_name="Test Group", id=None, type="group"),
+ "update",
+ False,
+ "Group ID is required to update a group.",
+ ),
+ (
+ GroupDetail(display_name="Test Group", repository=None, type="group"),
+ "create",
+ False,
+ "Repository ID is required to create a group.",
+ ),
+ (
+ GroupDetail(display_name="Test Group", repository=GroupRepository(id="repo1"), type="group"),
+ "create",
+ False,
+ "Repository with ID 'repo1' does not exist.",
+ ),
+ (
+ GroupDetail(
+ display_name="Test Group", repository=GroupRepository(id="repo1"), user_defined_id=None, type="group"
+ ),
+ "create",
+ True,
+ "Group ID is required to create a group.",
+ ),
+ (
+ GroupDetail(
+ display_name="Test Group",
+ repository=GroupRepository(id="repo1"),
+ user_defined_id="very_very_very_very_very_very_long_group_id",
+ type="group",
+ ),
+ "create",
+ True,
+ "Group ID is too long.",
+ ),
+ ],
+)
+def test_validate_group_to_map_group_error(app, mocker: MockerFixture, group, mode, repository_exist, expected):
+ repository = RepositoryDetail(id="repo1") if repository_exist else None
+ mocker.patch("server.services.repositories.get_by_id", return_value=repository)
+ with pytest.raises(InvalidFormError) as exc:
+ transformers.validate_group_to_map_group(group=group, mode=mode)
+ assert str(exc.value) == expected
+
+
+@pytest.mark.parametrize(
+ ("private_attr", "expected"),
+ [
+ (
+ (None, None, None),
+ MapGroup(
+ id="jc_repo1_gr_test_group_test",
+ display_name="Test Group",
+ public=True,
+ description="Test Description",
+ member_list_visibility="Public",
+ members=None,
+ administrators=None,
+ services=None,
+ ),
+ ),
+ (
+ ([UserSummary(id="user1")], [UserSummary(id="admin1")], [GroupService_(id="service1")]),
+ MapGroup(
+ id="jc_repo1_gr_test_group_test",
+ display_name="Test Group",
+ public=True,
+ description="Test Description",
+ member_list_visibility="Public",
+ members=[MemberUser(value="user1")],
+ administrators=[GroupAdministrator(value="admin1")],
+ services=[GroupService(value="service1")],
+ ),
+ ),
+ ],
+)
+def test_make_map_group(app, mocker: MockerFixture, private_attr, expected):
+ group = GroupDetail(
+ id="jc_repo1_gr_test_group_test",
+ display_name="Test Group",
+ public=True,
+ description="Test Description",
+ member_list_visibility="Public",
+ type="group",
+ )
+ users, admins, services = private_attr
+ group._users = users # noqa: SLF001
+ group._admins = admins # noqa: SLF001
+ group._services = services # noqa: SLF001
+ assert transformers.make_map_group(group) == expected
+
+
+def test_prepare_user(app, mocker: MockerFixture):
+ user_detail = UserDetail(id="user1", user_name="Test User")
+ return_fnc = mocker.patch(
+ "server.services.utils.transformers.validate_user_to_map_user", return_value=MapUser(id="user1")
+ )
+ transformers.prepare_user(user_detail)
+ return_fnc.assert_called_once_with(user_detail, mode="create")
+
+
+@pytest.mark.parametrize(
+ ("map_user", "affiliations", "is_system_admin", "expected"),
+ [
+ (
+ MapUser(
+ id="user1",
+ user_name="Test User",
+ preferred_language="ja",
+ edu_person_principal_names=[EPPN(value="test_eppn")],
+ emails=[Email(value="test@example.com")],
+ meta=UserMeta(
+ created=datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC),
+ last_modified=datetime(2026, 1, 2, 0, 0, 0, tzinfo=UTC),
+ created_by=None,
+ ),
+ ),
+ Affiliations(roles=[], groups=[]),
+ True,
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ preferred_language="ja",
+ eppns=["test_eppn"],
+ emails=["test@example.com"],
+ created=datetime(2026, 1, 1, 0, 0, 0, tzinfo=UTC),
+ last_modified=datetime(2026, 1, 2, 0, 0, 0, tzinfo=UTC),
+ ),
+ ),
+ (
+ MapUser(id="user1", user_name="Test User", groups=[UserGroup(value="jc_repo1_gr_test_group")]),
+ Affiliations(
+ roles=[_RoleGroup(repository_id=None, role=USER_ROLES.SYSTEM_ADMIN)],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test_group", user_defined_id="test_group")],
+ ),
+ True,
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ is_system_admin=True,
+ ),
+ ),
+ (
+ MapUser(id="user1", user_name="Test User", groups=[UserGroup(value="jc_repo1_gr_test_group")]),
+ Affiliations(
+ roles=[_RoleGroup(repository_id="repo1", role=USER_ROLES.REPOSITORY_ADMIN)],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test_group", user_defined_id="test_group")],
+ ),
+ False,
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ repository_roles=[RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN)],
+ groups=[GroupSummary(id="jc_repo1_gr_test_group")],
+ ),
+ ),
+ ],
+)
+def test_make_user_detail(app, mocker: MockerFixture, map_user, affiliations, is_system_admin, expected):
+ mocker.patch("server.services.utils.transformers.get_permitted_repository_ids", return_value={"repo1"})
+ mocker.patch("server.services.utils.transformers.detect_affiliations", return_value=affiliations)
+ mocker.patch("server.services.utils.transformers.is_current_user_system_admin", return_value=is_system_admin)
+ mocker.patch("server.services.utils.transformers.make_criteria_object", return_value=None)
+ user_detail = transformers.make_user_detail(map_user)
+ assert user_detail == expected
+
+
+@pytest.mark.parametrize(
+ ("map_user", "permitted_repository_ids", "affiliations", "expected"),
+ [
+ (
+ MapUser(id="user1", user_name="Test User", groups=[UserGroup(value="jc_repo1_gr_test_group")]),
+ {"repo1"},
+ Affiliations(
+ roles=[_RoleGroup(repository_id="repo1", role=USER_ROLES.REPOSITORY_ADMIN)],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test_group", user_defined_id="test_group")],
+ ),
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ repository_roles=[RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN)],
+ groups=[GroupSummary(id="jc_repo1_gr_test_group")],
+ ),
+ ),
+ (
+ MapUser(id="user1", user_name="Test User", groups=[UserGroup(value="jc_repo1_gr_test_group")]),
+ set(),
+ Affiliations(
+ roles=[_RoleGroup(repository_id="repo1", role=USER_ROLES.REPOSITORY_ADMIN)],
+ groups=[_Group(repository_id="repo1", group_id="jc_repo1_gr_test_group", user_defined_id="test_group")],
+ ),
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ ),
+ ),
+ ],
+)
+def test_make_user_detail_more(app, mocker: MockerFixture, map_user, permitted_repository_ids, affiliations, expected):
+ mocker.patch(
+ "server.services.utils.transformers.get_permitted_repository_ids", return_value=permitted_repository_ids
+ )
+ mocker.patch("server.services.utils.transformers.detect_affiliations", return_value=affiliations)
+ mocker.patch("server.services.utils.transformers.is_current_user_system_admin", return_value=False)
+ mocker.patch("server.services.utils.transformers.make_criteria_object", return_value=None)
+ mocker.patch(
+ "server.services.groups.search",
+ return_value=SearchResult[GroupSummary](
+ total=1, page_size=20, offset=1, resources=[GroupSummary(id="jc_repo1_gr_test_group")]
+ ),
+ )
+ mocker.patch(
+ "server.services.repositories.search",
+ return_value=SearchResult[RepositorySummary](
+ total=1, page_size=20, offset=1, resources=[RepositorySummary(id="repo1")]
+ ),
+ )
+ user_detail = transformers.make_user_detail(map_user, more_detail=True)
+ assert user_detail == expected
+
+
+@pytest.mark.parametrize(
+ ("user_detail", "expectedarg", "expected_exception"),
+ [
+ (
+ UserDetail(id="user1", user_name=""),
+ "Username is required to create a user.",
+ InvalidFormError,
+ ),
+ (
+ UserDetail(id=None, user_name="Test User", eppns=[]),
+ "At least one eduPersonPrincipalName is required to create a user.",
+ InvalidFormError,
+ ),
+ (
+ UserDetail(id="user1", user_name="Test User", eppns=["test_eppn"], emails=[]),
+ "At least one email is required to create a user.",
+ InvalidFormError,
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[GroupSummary(id="jc_not_repo_gr_test_group")],
+ ),
+ "Cannot specify groups that do not exist.",
+ InvalidFormError,
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[GroupSummary(id="jc_repo1_gr_test_group")],
+ is_system_admin=True,
+ repository_roles=[RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN)],
+ ),
+ "System administrator cannot be affiliated with any repository.",
+ InvalidFormError,
+ ),
+ ],
+)
+def test_validate_user_to_map_user_create(app, mocker: MockerFixture, user_detail, expectedarg, expected_exception):
+ mocker.patch(
+ "server.services.groups.search",
+ return_value=SearchResult[GroupSummary](
+ total=1, page_size=20, offset=1, resources=[GroupSummary(id="jc_repo1_gr_test_group")]
+ ),
+ )
+ with pytest.raises(expected_exception) as exc:
+ transformers.validate_user_to_map_user(user_detail, mode="create")
+ assert str(exc.value) == expectedarg
+
+
+@pytest.mark.parametrize(
+ ("user_detail", "exist_repository", "expectedarg", "expected_exception"),
+ [
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[],
+ is_system_admin=False,
+ repository_roles=None,
+ ),
+ None,
+ "At least one repository and role is required.",
+ InvalidFormError,
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[],
+ is_system_admin=False,
+ repository_roles=[RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN)],
+ ),
+ None,
+ "Cannot specify repositories that do not exist.",
+ InvalidFormError,
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[],
+ is_system_admin=True,
+ repository_roles=[],
+ ),
+ RepositoryDetail(id="repo1"),
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[GroupSummary(id="jc_roles_sysadm_test")],
+ is_system_admin=True,
+ repository_roles=[],
+ ),
+ None,
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[],
+ is_system_admin=False,
+ repository_roles=[
+ RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN),
+ RepositoryRole(id="repo2", user_role=None),
+ ],
+ ),
+ RepositoryDetail(id="repo1"),
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[GroupSummary(id="jc_repo1_ro_radm_test")],
+ is_system_admin=False,
+ repository_roles=[
+ RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN),
+ RepositoryRole(id="repo2", user_role=None),
+ ],
+ ),
+ None,
+ ),
+ ],
+)
+def test_validate_user_to_map_user_update(
+ app, mocker: MockerFixture, user_detail, exist_repository, expectedarg, expected_exception
+):
+ mocker.patch(
+ "server.services.repositories.get_by_id",
+ return_value=exist_repository,
+ )
+ if expected_exception:
+ with pytest.raises(expected_exception) as exc:
+ transformers.validate_user_to_map_user(user_detail, mode="update")
+ assert str(exc.value) == expectedarg
+ else:
+ return_fnc = mocker.patch(
+ "server.services.utils.transformers.make_map_user",
+ return_value=SearchResult[GroupSummary](
+ total=1, page_size=20, offset=1, resources=[GroupSummary(id="jc_repo1_gr_test_group")]
+ ),
+ )
+ transformers.validate_user_to_map_user(user_detail, mode="update")
+ return_fnc.assert_called_once_with(expectedarg)
+
+
+@pytest.mark.parametrize(
+ ("user_detail", "expected"),
+ [
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ groups=[GroupSummary(id="jc_repo1_gr_test_group")],
+ repository_roles=[RepositoryRole(id="repo1", user_role=USER_ROLES.REPOSITORY_ADMIN)],
+ ),
+ MapUser(
+ id="user1",
+ user_name="Test User",
+ edu_person_principal_names=[EPPN(value="test_eppn")],
+ emails=[Email(value="test@email.com")],
+ groups=[UserGroup(value="jc_repo1_gr_test_group"), UserGroup(value="jc_repo1_ro_radm_test")],
+ ),
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=["test_eppn"],
+ emails=["test@email.com"],
+ is_system_admin=True,
+ groups=[GroupSummary(id="jc_repo1_gr_test_group")],
+ ),
+ MapUser(
+ id="user1",
+ user_name="Test User",
+ edu_person_principal_names=[EPPN(value="test_eppn")],
+ emails=[Email(value="test@email.com")],
+ groups=[UserGroup(value="jc_repo1_gr_test_group"), UserGroup(value="jc_roles_sysadm_test")],
+ ),
+ ),
+ (
+ UserDetail(
+ id="user1",
+ user_name="Test User",
+ eppns=[],
+ emails=[],
+ groups=[],
+ repository_roles=[],
+ ),
+ MapUser(id="user1", user_name="Test User"),
+ ),
+ ],
+)
+def test_make_map_user(app, mocker: MockerFixture, user_detail, expected):
+ assert transformers.make_map_user(user_detail) == expected
diff --git a/tests/unit/services/test_utils_affiliations.py b/tests/unit/services/test_utils_affiliations.py
index 943ffe48..50e48c05 100644
--- a/tests/unit/services/test_utils_affiliations.py
+++ b/tests/unit/services/test_utils_affiliations.py
@@ -14,24 +14,24 @@
def test_detect_affiliations(app):
group_ids = [
"jc_roles_sysadm_test", # sysado
- "jc_test_ac_jp_roles_repoadm_test", # repoado
- "jc_test_ac_jp_roles_comadm_test", # comado
- "jc_test_ac_jp_roles_contributor_test", # contributer
- "jc_test_ac_jp_roles_generaluser_test", # generaluser
- "jc_test_ac_jp_groups_test3_test",
+ "jc_test_ac_jp_ro_radm_test", # repoado
+ "jc_test_ac_jp_ro_cadm_test", # comado
+ "jc_test_ac_jp_ro_cont_test", # contributer
+ "jc_test_ac_jp_ro_user_test", # generaluser
+ "jc_test_ac_jp_gr_test3_test",
] # user
result = detect_affiliations(group_ids)
expected_repository_id_sys = None
- expected_roles_sys = ["system_admin"]
+ expected_ro_sys = ["system_admin"]
expected_rolegroup_type = "role"
expected_repository_id = "test_ac_jp"
expected_roles = ["repository_admin", "community_admin", "contributor", "general_user"]
expected_group_repository_id = "test_ac_jp"
- expected_group_id = "jc_test_ac_jp_groups_test3_test"
+ expected_group_id = "jc_test_ac_jp_gr_test3_test"
expected_user_defined_id = "test3"
expected_group_type = "group"
expected_length = [2, 1]
@@ -39,15 +39,15 @@ def test_detect_affiliations(app):
assert len(result.roles) == expected_length[0]
assert len(result.groups) == expected_length[1]
- result_roles_0 = result.roles[0]
- assert result_roles_0.type == expected_rolegroup_type
- assert result_roles_0.repository_id == expected_repository_id_sys
- assert result_roles_0.role == expected_roles_sys[0]
+ result_ro_0 = result.roles[0]
+ assert result_ro_0.type == expected_rolegroup_type
+ assert result_ro_0.repository_id == expected_repository_id_sys
+ assert result_ro_0.role == expected_ro_sys[0]
- result_roles_1 = result.roles[1]
- assert result_roles_1.type == expected_rolegroup_type
- assert result_roles_1.repository_id == expected_repository_id
- assert sorted(result_roles_1.role) == sorted(expected_roles[0])
+ result_ro_1 = result.roles[1]
+ assert result_ro_1.type == expected_rolegroup_type
+ assert result_ro_1.repository_id == expected_repository_id
+ assert sorted(result_ro_1.role) == sorted(expected_roles[0])
result_groups_0 = result.groups[0]
assert result_groups_0.type == expected_group_type
@@ -57,7 +57,7 @@ def test_detect_affiliations(app):
def test_detect_affiliation_no_match(app):
- result = detect_affiliation("test1_roles_repoadm_test")
+ result = detect_affiliation("test1_ro_radm_test")
expected = None
assert result == expected
@@ -66,12 +66,12 @@ def test_detect_affiliation_no_match(app):
("group_id", "expected_repository_id", "expected_roles", "expected_type"),
[
("jc_roles_sysadm_test", None, ["system_admin"], "role"),
- ("jc_test_ac_jp_roles_repoadm_test", "test_ac_jp", ["repository_admin"], "role"),
- ("jc_test_ac_jp_roles_comadm_test", "test_ac_jp", ["community_admin"], "role"),
- ("jc_test_ac_jp_roles_contributor_test", "test_ac_jp", ["contributor"], "role"),
- ("jc_test_ac_jp_roles_generaluser_test", "test_ac_jp", ["general_user"], "role"),
+ ("jc_test_ac_jp_ro_radm_test", "test_ac_jp", ["repository_admin"], "role"),
+ ("jc_test_ac_jp_ro_cadm_test", "test_ac_jp", ["community_admin"], "role"),
+ ("jc_test_ac_jp_ro_cont_test", "test_ac_jp", ["contributor"], "role"),
+ ("jc_test_ac_jp_ro_user_test", "test_ac_jp", ["general_user"], "role"),
],
- ids=["sysadm", "repoadm", "comadm", "contributer", "generaluser"],
+ ids=["sysadm", "radm", "cadm", "cont", "user"],
)
def test_detect_affiliation_role_group(app, group_id, expected_repository_id, expected_roles, expected_type):
result = detect_affiliation(group_id)
@@ -84,11 +84,11 @@ def test_detect_affiliation_role_group(app, group_id, expected_repository_id, ex
def test_detect_affiliation_group(app):
expected_repository_id = "test_ac_jp"
- expected_group_id = "jc_test_ac_jp_groups_test3_test"
+ expected_group_id = "jc_test_ac_jp_gr_test3_test"
expected_user_defined_id = "test3"
expected_type = "group"
- result = detect_affiliation("jc_test_ac_jp_groups_test3_test")
+ result = detect_affiliation("jc_test_ac_jp_gr_test3_test")
assert result is not None
assert isinstance(result, _Group)
assert result.repository_id == expected_repository_id
@@ -106,28 +106,28 @@ def test_build_combined_regex_sys(app):
def test_build_combined_regex_repo(app):
pattern = _build_combined_regex().pattern
- expected = "(?Pjc_(?P.+?)_roles_repoadm_test)"
+ expected = "(?Pjc_(?P.+?)_ro_radm_test)"
assert expected in pattern
def test_build_combined_regex_com(app):
pattern = _build_combined_regex().pattern
- expected = "(?Pjc_(?P.+?)_roles_comadm_test)"
+ expected = "(?Pjc_(?P.+?)_ro_cadm_test)"
assert expected in pattern
def test_build_combined_regex_con(app):
pattern = _build_combined_regex().pattern
- expected = "(?Pjc_(?P.+?)_roles_contributor_test)"
+ expected = "(?Pjc_(?P.+?)_ro_cont_test)"
assert expected in pattern
def test_build_combined_regex_gene(app):
pattern = _build_combined_regex().pattern
- expected = "(?Pjc_(?P.+?)_roles_generaluser_test)"
+ expected = "(?Pjc_(?P.+?)_ro_user_test)"
assert expected in pattern
@@ -135,7 +135,7 @@ def test_build_combined_regex_gene(app):
def test_build_combined_regex_user(app):
pattern = _build_combined_regex().pattern
expected = (
- "(?Pjc_(?P.+?)_groups_(?P.+?)_test)"
+ "(?Pjc_(?P.+?)_gr_(?P.+?)_test)"
)
assert expected in pattern
diff --git a/tests/unit/test_auth.py b/tests/unit/test_auth.py
new file mode 100644
index 00000000..a375477c
--- /dev/null
+++ b/tests/unit/test_auth.py
@@ -0,0 +1,168 @@
+import typing as t
+
+from datetime import UTC, datetime, timedelta
+
+from flask import session
+from flask_login import current_user, login_user
+
+from server import auth
+from server.entities.login_user import LoginUser
+
+
+if t.TYPE_CHECKING:
+ from pytest_mock import MockerFixture
+
+mock_repoadmin_login_user = LoginUser(
+ eppn="test_eppn",
+ is_member_of="https://cg.gakunin.jp/gr/group1;https://cg.gakunin.jp/gr/jc_test_roles_repoadm",
+ user_name="Test User",
+ map_id="test_user_id",
+ session_id="",
+)
+
+
+def test_is_user_logged_in(app):
+ with app.test_request_context("/"):
+ login_user(mock_repoadmin_login_user)
+ assert auth.is_user_logged_in(current_user)
+
+
+def test_is_user_logged_in_not_logged_in(app):
+ with app.test_request_context("/"):
+ assert not auth.is_user_logged_in(current_user)
+
+
+def test_refresh_session_not_logged_in(app, datastore):
+ _, account_store, _ = datastore
+ with app.test_request_context("/"):
+ res = auth.refresh_session()
+ assert res is None
+ account_store.expire.assert_not_called()
+ account_store.delete.assert_not_called()
+
+
+def test_refresh_session_no_data(app, datastore):
+ _, account_store, _ = datastore
+ with app.test_request_context("/"):
+ login_user(mock_repoadmin_login_user)
+ res = auth.refresh_session()
+ assert res is None
+ account_store.expire.assert_not_called()
+ account_store.delete.assert_not_called()
+
+
+def test_refresh_session(app, datastore, mocker: MockerFixture):
+ _, account_store, _ = datastore
+ test_session_id = "test_session_id"
+ test_login_date = datetime.now(UTC).isoformat()
+ account_store.hget.return_value = test_login_date.encode("utf-8")
+ with app.test_request_context("/"):
+ login_user(mock_repoadmin_login_user)
+ session["_id"] = test_session_id
+ res = auth.refresh_session()
+ assert res is None
+ account_store.expire.assert_called_once()
+
+
+def test_refresh_session_over(app, datastore, mocker: MockerFixture):
+ _, account_store, _ = datastore
+ test_session_id = "test_session_id"
+ expired_login_date = (datetime.now(UTC) - timedelta(seconds=60 * 60 * 24)).isoformat()
+ account_store.hget.return_value = expired_login_date.encode("utf-8")
+ with app.test_request_context("/"):
+ login_user(mock_repoadmin_login_user)
+ session["_id"] = test_session_id
+ res = auth.refresh_session()
+ assert res is None
+ account_store.delete.assert_called_once()
+
+
+def test_refresh_session_absolute(app, datastore, mocker: MockerFixture):
+ mocker.patch("server.config.config.SESSION.strategy", "absolute")
+ _, account_store, _ = datastore
+ with app.test_request_context("/"):
+ res = auth.refresh_session()
+ assert res is None
+ account_store.expire.assert_not_called()
+ account_store.delete.assert_not_called()
+
+
+def test_refresh_session_invalid_ttl(app, datastore, mocker: MockerFixture):
+ _, account_store, _ = datastore
+ test_session_id = "test_session_id"
+ test_login_date = datetime.now(UTC).isoformat()
+ account_store.hget.return_value = test_login_date.encode("utf-8")
+ mocker.patch("server.config.config.SESSION.sliding_lifetime", -1)
+ with app.test_request_context("/"):
+ login_user(mock_repoadmin_login_user)
+ session["_id"] = test_session_id
+ res = auth.refresh_session()
+ assert res is None
+ account_store.expire.assert_not_called()
+
+
+def test_load_user_not_eppn():
+ empty_eppn = ""
+ user = auth.load_user(empty_eppn)
+ assert user is None
+
+
+def test_load_user_not_session_id(app):
+ test_eppn = "test_eppn"
+ with app.test_request_context("/"):
+ user = auth.load_user(test_eppn)
+ assert user is None
+
+
+def test_load_user_invalid_eppn(app, mocker: MockerFixture):
+ test_invalid_eppn = "test_invalid_eppn"
+ test_session_id = "test_session_id"
+ with app.test_request_context("/"):
+ mocker.patch("server.auth.get_user_from_store", return_value=mock_repoadmin_login_user)
+ session["_id"] = test_session_id
+ user = auth.load_user(test_invalid_eppn)
+ assert user is None
+
+
+def test_load_user(app, mocker: MockerFixture):
+ test_eppn = "test_eppn"
+ test_session_id = "test_session_id"
+ with app.test_request_context("/"):
+ mocker.patch("server.auth.get_user_from_store", return_value=mock_repoadmin_login_user)
+ session["_id"] = test_session_id
+ user = auth.load_user(test_eppn)
+ assert user == mock_repoadmin_login_user
+
+
+def test_get_user_from_store_valid(app, datastore):
+ _, account_store, _ = datastore
+ test_session_id = "test_session_id"
+ user_dict = {
+ b"eppn": b"test_eppn",
+ b"is_member_of": b"https://cg.gakunin.jp/gr/group1",
+ b"user_name": b"Test User",
+ b"map_id": b"test_user_id",
+ }
+ account_store.hgetall.return_value = user_dict
+ with app.test_request_context("/"):
+ user = auth.get_user_from_store(test_session_id)
+ assert isinstance(user, LoginUser)
+ assert user.eppn == "test_eppn"
+ assert user.session_id == test_session_id
+
+
+def test_get_user_from_store_none(app, datastore):
+ _, account_store, _ = datastore
+ test_session_id = "test_session_id"
+ account_store.hgetall.return_value = None
+ with app.test_request_context("/"):
+ user = auth.get_user_from_store(test_session_id)
+ assert user is None
+
+
+def test_build_account_store_key(app, test_config):
+ session_id = "test_session_id"
+ with app.test_request_context("/"):
+ key = auth.build_account_store_key(session_id)
+ prefix = test_config.REDIS.key_prefix
+ assert key == f"{prefix}login-{session_id}"