پرس و جو نمودار اقدام (پرس و جو)

دستور aquery به شما این امکان را می دهد که برای اقدامات در نمودار ساخت خود پرس و جو کنید. این بر روی نمودار هدف پیکربندی شده پس از تجزیه و تحلیل عمل می کند و اطلاعات مربوط به Actions، Artifacts و روابط آنها را در معرض دید قرار می دهد.

aquery زمانی مفید است که به ویژگی‌های Actions/Artifacts تولید شده از نمودار هدف پیکربندی شده علاقه دارید. به عنوان مثال، دستورات واقعی اجرا می‌شوند و ورودی/خروجی‌ها/مانمونیک‌های آن‌ها.

این ابزار چندین گزینه خط فرمان را می پذیرد. نکته قابل توجه، دستور aquery در بالای یک ساخت معمولی Bazel اجرا می شود و مجموعه ای از گزینه های موجود در طول ساخت را به ارث می برد.

از همان مجموعه ای از توابع پشتیبانی می کند که برای query سنتی اما siblings ، buildfiles های ساخت و tests ها نیز در دسترس است.

یک نمونه خروجی aquery و جو (بدون جزئیات خاص):

$ bazel aquery 'deps(//some:label)'
action 'Writing file some_file_name'
  Mnemonic: ...
  Target: ...
  Configuration: ...
  ActionKey: ...
  Inputs: [...]
  Outputs: [...]

نحو پایه

یک مثال ساده از نحو برای aquery به شرح زیر است:

bazel aquery "aquery_function(function(//target))"

عبارت پرس و جو (در نقل قول) شامل موارد زیر است:

• aquery_function(...) : توابع خاص aquery . جزئیات بیشتر در زیر .
• function(...) : توابع استاندارد به عنوان query سنتی عمل می کند.
• //target برچسبی است برای هدف علاقه مند.

# aquery examples:
# Get the action graph generated while building //src/target_a
$ bazel aquery '//src/target_a'

# Get the action graph generated while building all dependencies of //src/target_a
$ bazel aquery 'deps(//src/target_a)'

# Get the action graph generated while building all dependencies of //src/target_a
# whose inputs filenames match the regex ".*cpp".
$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

استفاده از توابع aquery

سه تابع aquery وجود دارد:

• inputs : فیلتر کردن اعمال توسط ورودی ها.
• outputs : فیلتر کردن اعمال توسط خروجی ها
• mnemonic : فیلتر کردن اعمال توسط یادگار

expr ::= inputs(word, expr)

عملگر inputs اقدامات ایجاد شده از ساختمان expr را برمی گرداند که نام فایل ورودی آن با regex ارائه شده توسط word مطابقت دارد.

$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'

outputs و توابع mnemonic یک نحو مشابه دارند.

همچنین می توانید توابع را برای دستیابی به عملیات AND ترکیب کنید. مثلا:

  $ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'

دستور بالا تمام اقدامات مربوط به ساخت //src/target_a را پیدا می کند، که یادداشت های آن با "Cpp.*" مطابقت دارد و ورودی ها با الگوهای ".*cpp" و "foo.*" مطابقت دارند.

نمونه ای از خطای نحوی تولید شده:

        $ bazel aquery 'deps(inputs(".*cpp", //src/target_a))'
        ERROR: aquery filter functions (inputs, outputs, mnemonic) produce actions,
        and therefore can't be the input of other function types: deps
        deps(inputs(".*cpp", //src/target_a))

گزینه ها

گزینه های ساخت

aquery بر روی یک ساخت معمولی Bazel اجرا می شود و بنابراین مجموعه گزینه های موجود در طول ساخت را به ارث می برد.

گزینه های Aquery

--output=(text|summary|proto|jsonproto|textproto), default=text

فرمت خروجی پیش‌فرض ( text ) قابل خواندن توسط انسان است، از proto ، textproto یا jsonproto برای قالب‌های قابل خواندن توسط ماشین استفاده کنید. پیام اولیه analysis.ActionGraphContainer است.ActionGraphContainer.

--include_commandline, default=true

شامل محتوای خطوط فرمان عمل در خروجی (به طور بالقوه بزرگ).

--include_artifacts, default=true

شامل نام ورودی ها و خروجی های عمل در خروجی (بالقوه بزرگ).

--include_aspects, default=true

آیا شامل اقدامات ایجاد شده توسط Aspect در خروجی می شود یا خیر.

--include_param_files, default=false

محتوای فایل‌های param مورد استفاده در دستور را درج کنید (به احتمال زیاد بزرگ).

--include_file_write_contents, default=false

شامل محتویات فایل برای عملکرد actions.write() و محتویات فایل مانیفست برای عمل SourceSymlinkManifest محتویات فایل در قسمت file_contents با --output= xxx proto بازگردانده می شود. با --output=text ، خروجی دارای خط FileWriteContents: [<base64-encoded file contents>] است.

--skyframe_state, default=false

بدون انجام تجزیه و تحلیل اضافی، Action Graph را از Skyframe تخلیه کنید.

سایر ابزارها و امکانات

پرس و جو علیه وضعیت Skyframe

Skyframe مدل ارزیابی و افزایشی بازل است. در هر نمونه از سرور Bazel، Skyframe نمودار وابستگی ساخته شده از اجرای قبلی مرحله تجزیه و تحلیل را ذخیره می کند.

در برخی موارد، جستجو در Action Graph در Skyframe مفید است. یک مثال استفاده از این موارد خواهد بود:

1. bazel build //target_a
2. bazel build //target_b
3. فایل foo.out ایجاد شد.

به عنوان یک کاربر Bazel، می‌خواهم تعیین کنم که آیا foo.out از ساختمان //target_a یا //target_b شده است.

می‌توان bazel aquery 'outputs("foo.out", //target_a)' و bazel aquery 'outputs("foo.out", //target_b)' را اجرا کرد تا عملی که مسئول ایجاد foo.out است و در هدف را بچرخانید با این حال، تعداد اهداف مختلفی که قبلا ساخته شده‌اند می‌تواند بزرگتر از 2 باشد، که اجرای چندین دستور aquery را با مشکل مواجه می‌کند.

به عنوان یک جایگزین، می توان از پرچم --skyframe_state استفاده کرد:

  # List all actions on Skyframe's action graph
  $ bazel aquery --output=proto --skyframe_state

  # or

  # List all actions on Skyframe's action graph, whose output matches "foo.out"
  $ bazel aquery --output=proto --skyframe_state 'outputs("foo.out")'

با حالت --skyframe_state ، aquery محتوای Action Graph را که Skyframe روی نمونه Bazel نگه می‌دارد، می‌گیرد، (به صورت اختیاری) فیلتر را روی آن انجام می‌دهد و محتوا را بدون اجرای مجدد مرحله تحلیل، خروجی می‌دهد.

ملاحظات خاص

فرمت خروجی

--skyframe_state در حال حاضر فقط برای --output=proto و --output=textproto در دسترس است

عدم درج برچسب های هدف در عبارت پرس و جو

در حال حاضر، --skyframe_state کل نمودار عملیاتی را که در Skyframe وجود دارد، بدون توجه به اهداف، پرس و جو می کند. داشتن برچسب هدف مشخص شده در پرس و جو همراه با --skyframe_state یک خطای نحوی در نظر گرفته می شود:

  # WRONG: Target Included
  $ bazel aquery --output=proto --skyframe_state **//target_a**
  ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported.

  # WRONG: Target Included
  $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java", **//target_a**)'
  ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported.

  # CORRECT: Without Target
  $ bazel aquery --output=proto --skyframe_state
  $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java")'

مقایسه خروجی های aquery

با استفاده از ابزار aquery_differ می‌توانید خروجی‌های دو فراخوانی مختلف را با هم مقایسه کنید. به عنوان مثال: هنگامی که تغییراتی در تعریف قانون خود ایجاد می کنید و می خواهید بررسی کنید که خطوط فرمان در حال اجرا تغییر نکرده اند. aquery_differ ابزاری برای آن است.

این ابزار در مخزن bazelbuild/bazel موجود است. برای استفاده از آن، مخزن را در دستگاه محلی خود کلون کنید. یک مثال استفاده:

  $ bazel run //tools/aquery_differ -- \
  --before=/path/to/before.proto \
  --after=/path/to/after.proto \
  --input_type=proto \
  --attrs=cmdline \
  --attrs=inputs

دستور بالا تفاوت بین خروجی های before و after پرس را برمی گرداند: کدام عملکردها در یکی وجود داشتند اما در دیگری وجود نداشتند، کدام عملکردها دارای خط فرمان/ورودی های مختلف در هر خروجی aquery هستند، ...). نتیجه اجرای دستور بالا این خواهد بود:

  Aquery output 'after' change contains an action that generates the following outputs that aquery output 'before' change doesn't:
  ...
  /list of output files/
  ...

  [cmdline]
  Difference in the action that generates the following output(s):
    /path/to/abc.out
  --- /path/to/before.proto
  +++ /path/to/after.proto
  @@ -1,3 +1,3 @@
    ...
    /cmdline diff, in unified diff format/
    ...

گزینه های فرمان

--before, --after : فایل های خروجی aquery که باید مقایسه شوند

--input_type=(proto|text_proto), default=proto : فرمت فایل های ورودی. پشتیبانی برای خروجی aquery proto و textproto ارائه شده است.

--attrs=(cmdline|inputs), default=cmdline : ویژگی های اقداماتی که باید مقایسه شوند.

جنبه در جنبه

این امکان وجود دارد که Aspect ها روی هم اعمال شوند. خروجی aquery کنش تولید شده توسط این جنبه‌ها سپس شامل مسیر Aspect می‌شود که دنباله‌ای از جنبه‌های اعمال شده روی هدفی است که اقدام را ایجاد کرده است.

نمونه ای از Aspect-on-Aspect:

  t0
  ^
  | <- a1
  t1
  ^
  | <- a2
  t2

بگذارید t _i یک هدف از قانون r _i باشد، که یک Aspect a _i را برای وابستگی های خود اعمال می کند.

فرض کنید که a2 یک عمل X را هنگامی که برای هدف t0 اعمال می شود ایجاد می کند. خروجی متن bazel aquery --include_aspects 'deps(//t2)' برای عمل X خواهد بود:

  action ...
  Mnemonic: ...
  Target: //my_pkg:t0
  Configuration: ...
  AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...)
    -> //my_pkg:rule.bzl%**a1**(bar=...)]
  ...

این بدان معنی است که عمل X توسط جنبه a2 اعمال شده بر روی a1(t0) ایجاد شده است، که در آن a1(t0) نتیجه جنبه a1 اعمال شده بر روی هدف t0 است.

هر AspectDescriptor فرمت زیر را دارد:

  AspectClass([param=value,...])

AspectClass می تواند نام کلاس Aspect (برای جنبه های بومی) یا bzl_file%aspect_name (برای Starlark Aspects) باشد. AspectDescriptor به ترتیب توپولوژیک نمودار وابستگی مرتب شده اند.

پیوند با نمایه JSON

در حالی که aquery اطلاعاتی در مورد اقدامات در حال اجرا در یک ساخت (چرا اجرا می‌شوند، ورودی/خروجی‌های آنها) ارائه می‌کند، نمایه JSON زمان و مدت اجرای آنها را به ما می‌گوید. ترکیب این 2 مجموعه اطلاعات از طریق یک مخرج مشترک امکان پذیر است: خروجی اولیه یک اقدام.

برای گنجاندن خروجی‌های کنش‌ها در نمایه JSON، نمایه را با --experimental_include_primary_output --noexperimental_slim_json_profile کنید. پروفیل های باریک با گنجاندن خروجی های اولیه ناسازگار هستند. خروجی اولیه یک اقدام به‌طور پیش‌فرض توسط پرسش‌نامه گنجانده می‌شود.

ما در حال حاضر ابزار متعارفی برای ترکیب این 2 منبع داده ارائه نمی کنیم، اما شما باید بتوانید اسکریپت خود را با اطلاعات بالا بسازید.

مشکلات شناخته شده

مدیریت اقدامات مشترک

گاهی اوقات اقدامات بین اهداف پیکربندی شده به اشتراک گذاشته می شود.

در مرحله اجرا، آن اقدامات مشترک به سادگی به عنوان یک و تنها یک بار اجرا می شوند. با این حال، aquery بر روی گراف اقدام قبل از اجرا و پس از تجزیه و تحلیل عمل می‌کند، و از این رو با آن‌ها مانند اکشن‌های جداگانه‌ای رفتار می‌کند که Artifactهای خروجی آن‌ها دقیقاً execPath یکسان دارند. در نتیجه، مصنوعات معادل تکراری به نظر می رسند.

لیست مشکلات پرسشنامه/ویژگی های برنامه ریزی شده را می توانید در GitHub پیدا کنید.

سوالات متداول

حتی اگر محتوای یک فایل ورودی تغییر کرده باشد، ActionKey ثابت می ماند.

در زمینه استعلام، ActionKey به String دریافت شده از ActionAnalysisMetadata#getKey اشاره دارد:

  Returns a string encoding all of the significant behaviour of this Action that might affect the
  output. The general contract of `getKey` is this: if the work to be performed by the
  execution of this action changes, the key must change.

  ...

  Examples of changes that should affect the key are:

  - Changes to the BUILD file that materially affect the rule which gave rise to this Action.
  - Changes to the command-line options, environment, or other global configuration resources
      which affect the behaviour of this kind of Action (other than changes to the names of the
      input/output files, which are handled externally).
  - An upgrade to the build tools which changes the program logic of this kind of Action
      (typically this is achieved by incorporating a UUID into the key, which is changed each
      time the program logic of this action changes).
  Note the following exception: for actions that discover inputs, the key must change if any
  input names change or else action validation may falsely validate.

این تغییرات در محتوای فایل های ورودی را حذف نمی کند و نباید با RemoteCacheClient#ActionKey اشتباه گرفته شود.

به روز رسانی ها

برای هر گونه مشکل/ویژگی درخواستی، لطفاً یک مشکل را اینجا ثبت کنید.