macadmins / macadmins/jamf-pro-sdk-python

[Bug] Create/Update Advanced Computer Search Methods Sending Empty Criteria

オープン
#55 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

bug
主要言語
Python
スター
69
フォーク
16
PR マージ指標
30日以内にマージされた PR はありません

説明

tl;dr when attempting to create or update an advanced computer search (using the create_advanced_computer_search or update_advanced_computer_search_by_id methods, respectively), the operation is completed successfully, except for the search criteria. Name and display fields are set as configured, but any criteria sent are seemingly ignored, and the search is created/updated with no criteria. This effectively places every device into the results for the advanced computer search.

Reproduction details below will be for creating a search, but the result is the same when attempting to update an existing search.

Steps to Reproduce
from jamf_pro_sdk import JamfProClient, SessionConfig
from jamf_pro_sdk.models.classic import computer_groups, advanced_computer_searches
from jamf_pro_sdk.models.classic.criteria import ClassicCriterion
from jamf_pro_sdk.clients.auth import ApiClientCredentialsProvider

jamfClient = JamfProClient(
	server=jamfURL,
	credentials=ApiClientCredentialsProvider(jamfClientID, jamfClientSecret),
	session_config=SessionConfig(**{"timeout": 30, "max_retries": 3}),
)

notUpdatedSearchData = advanced_computer_searches.ClassicAdvancedComputerSearch(
	name="macOS Version Not Current",
	criteria=[
		ClassicCriterion(
			name='Managed',
			priority=0,
			and_or='and',
			search_type='is',
			value='Managed',
			opening_paren=False,
			closing_paren=False
		),
		ClassicCriterion(
			name='Operating System Version',
			priority=1,
			and_or='and',
			search_type='less than',
			value='15.1',
			opening_paren=False,
			closing_paren=False
		)
	],
	display_fields=[
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="JSS Computer ID"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Last Check-in"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Serial Number"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Operating System Version"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Username"
		),
	],
)

searchID = jamfClient.classic_api.create_advanced_computer_search(data=notUpdatedSearchData)
searchData = jamfClient.classic_api.get_advanced_computer_search_by_id(advanced_search=searchID)
print(searchData)

Expected Result

Expected an advanced computer search to be created with the following criteria:
image

Actual Result

Advanced computer search created with no criteria:
image

id=6 name='macOS Version Not Current' site=ClassicSite(id=-1, name='None') criteria=[] display_fields=[ClassicAdvancedComputerSearchDisplayField(name='Username'), ClassicAdvancedComputerSearchDisplayField(name='Operating System Version'), ClassicAdvancedComputerSearchDisplayField(name='JSS Computer ID'), ClassicAdvancedComputerSearchDisplayField(name='Serial Number'), ClassicAdvancedComputerSearchDisplayField(name='Last Check-in')] 

(omitted computers from above output)

Additional Data

If I retrieve the criteria from an existing advanced computer search (with correct criteria) and feed that directly into the create method, I would definitely expect this criteria to be valid and accepted. Even doing this, the new search is created with no criteria:

knownGoodSearchCriteria = jamfClient.classic_api.get_advanced_computer_search_by_id(advanced_search=5).criteria
print(knownGoodSearchCriteria)

####
[ClassicCriterion(name='Managed', priority=0, and_or='and', search_type='is', value='Managed', opening_paren=False, closing_paren=False), ClassicCriterion(name='Operating System Version', priority=1, and_or='and', search_type='less than', value='15.1', opening_paren=False, closing_paren=False)]
####

notUpdatedSearchData = advanced_computer_searches.ClassicAdvancedComputerSearch(
	name="macOS Version Not Current",
	criteria=knownGoodSearchCriteria,
	display_fields=[
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="JSS Computer ID"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Last Check-in"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Serial Number"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Operating System Version"
		),
		advanced_computer_searches.ClassicAdvancedComputerSearchDisplayField(
			name="Username"
		),
	],
)

searchID = jamfClient.classic_api.create_advanced_computer_search(data=notUpdatedSearchData)
searchData = jamfClient.classic_api.get_advanced_computer_search_by_id(advanced_search=searchID)

print(searchData)

####
id=7 name='macOS Version Not Current' site=ClassicSite(id=-1, name='None') criteria=[] display_fields=[ClassicAdvancedComputerSearchDisplayField(name='Username'), ClassicAdvancedComputerSearchDisplayField(name='JSS Computer ID'), ClassicAdvancedComputerSearchDisplayField(name='Last Check-in'), ClassicAdvancedComputerSearchDisplayField(name='Serial Number'), ClassicAdvancedComputerSearchDisplayField(name='Operating System Version')]
####

(again omitted computers)

System Information

macOS 15.1
Python 3.12.1
SDK 0.6a2
Jamf Pro 11.10.2

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

エントリポイント create_advanced_computer_search と update_advanced_computer_search_by_id から開始し、ClassicAdvancedComputerSearch.criteria が Jamf Pro リクエスト用にどのようにシリアライズされるかを追跡します。提供された criteria の例で問題を再現し、検索の作成と更新によって、ID で取得した際に criteria が保持されることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。