जांच करना

बज़ेल में Starlark कोड की जांच करने के कई अलग-अलग तरीके हैं. यह पेज इस्तेमाल के उदाहरण के हिसाब से मौजूदा सबसे सही तरीकों और फ़्रेमवर्क को इकट्ठा करता है.

जांच के नियम

Skylib में नियमों का विश्लेषण करने के समय जैसे कि उनकी कार्रवाइयों और सेवा देने वाली कंपनियों की जांच करने के लिए, एक टेस्ट फ़्रेमवर्क होता है जिसे unittest.bzl कहा जाता है. इस तरह की जांच को "विश्लेषण जांच" कहा जाता है. फ़िलहाल, यह नियमों की आंतरिक जाँच का सबसे अच्छा विकल्प है.

कुछ चेतावनियां:

  • जांच में किए गए दावे बिल्ड के अंदर होते हैं, न कि अलग-अलग टेस्ट करने वाले की प्रोसेस पर. टेस्ट के ज़रिए बनाए गए टारगेट को इस तरह नाम देना चाहिए कि वे दूसरे टेस्ट के टारगेट या बिल्ड के टारगेट से न टकराएं. टेस्ट के दौरान होने वाली गड़बड़ी को बैजल एक टेस्ट असफलता के बजाय बिल्ड ब्रेकेज के रूप में देखता है.

  • इसके लिए, बॉयलरप्लेट की सही मात्रा की ज़रूरत होती है, ताकि टेस्ट के तहत नियमों को सेट अप किया जा सके और टेस्ट दावों वाले नियमों को सेट किया जा सके. पहली बार में यह बॉयलरप्लेट मुश्किल लग सकती है. इससे ध्यान रखें कि लोडिंग चरण के दौरान मैक्रो का मूल्यांकन किया जाता है और टारगेट जनरेट किए जाते हैं, जबकि नियम लागू करने के दौरान नियम लागू नहीं किए जाते.

  • विश्लेषण की जांच का मकसद काफ़ी छोटा और हल्का होना है. विश्लेषण की जांच करने वाले फ़्रेमवर्क की कुछ सुविधाएं, ज़्यादा से ज़्यादा ट्रांज़िट करने वाली डिपेंडेंसी (फ़िलहाल, 500) के साथ टारगेट की पुष्टि करने तक सीमित हैं. ऐसा, बड़े पैमाने पर इन सुविधाओं के साथ बड़े पैमाने पर जांच के परफ़ॉर्मेंस पर असर डालने की वजह से होता है.

बुनियादी सिद्धांत यह है कि किसी नियम को छांटने के नियम के आधार पर उसे तय किया जाए. इससे टेस्टिंग के नियम की जांच करने वाली कंपनियों को ऐक्सेस देने के लिए टेस्ट नियम का ऐक्सेस मिल जाता है.

जांच के नियम को लागू करने के फ़ंक्शन में दावे किए जाते हैं. अगर कोई गड़बड़ी होती है, तो ये fail() पर कॉल करके तुरंत नहीं बताए जाते हैं (जो जांच के समय तैयार होने वाली गड़बड़ी को ट्रिगर करते हैं). इसके बजाय, ये गड़बड़ियां जनरेट होने वाली स्क्रिप्ट में सेव नहीं की जाती हैं परीक्षण के समय.

नीचे एक छोटे से खिलौने का उदाहरण देखें, जिसके बाद कार्रवाइयों की जांच करने वाला उदाहरण देखें.

कम से कम उदाहरण

//mypkg/myrules.bzl:

MyInfo = provider(fields = {
    "val": "string value",
    "out": "output File",
})

def _myrule_impl(ctx):
    """Rule that just generates a file and returns a provider."""
    out = ctx.actions.declare_file(ctx.label.name + ".out")
    ctx.actions.write(out, "abc")
    return [MyInfo(val="some value", out=out)]

myrule = rule(
    implementation = _myrule_impl,
)

//mypkg/myrules_test.bzl:

load("@bazel_skylib//lib:unittest.bzl", "asserts", "analysistest")
load(":myrules.bzl", "myrule", "MyInfo")

# ==== Check the provider contents ====

def _provider_contents_test_impl(ctx):
    env = analysistest.begin(ctx)

    target_under_test = analysistest.target_under_test(env)
    # If preferred, could pass these values as "expected" and "actual" keyword
    # arguments.
    asserts.equals(env, "some value", target_under_test[MyInfo].val)

    # If you forget to return end(), you will get an error about an analysis
    # test needing to return an instance of AnalysisTestResultInfo.
    return analysistest.end(env)

# Create the testing rule to wrap the test logic. This must be bound to a global
# variable, not called in a macro's body, since macros get evaluated at loading
# time but the rule gets evaluated later, at analysis time. Since this is a test
# rule, its name must end with "_test".
provider_contents_test = analysistest.make(_provider_contents_test_impl)

# Macro to setup the test.
def _test_provider_contents():
    # Rule under test. Be sure to tag 'manual', as this target should not be
    # built using `:all` except as a dependency of the test.
    myrule(name = "provider_contents_subject", tags = ["manual"])
    # Testing rule.
    provider_contents_test(name = "provider_contents_test",
                           target_under_test = ":provider_contents_subject")
    # Note the target_under_test attribute is how the test rule depends on
    # the real rule target.

# Entry point from the BUILD file; macro for running each test case's macro and
# declaring a test suite that wraps them together.
def myrules_test_suite(name):
    # Call all test functions and wrap their targets in a suite.
    _test_provider_contents()
    # ...

    native.test_suite(
        name = name,
        tests = [
            ":provider_contents_test",
            # ...
        ],
    )

//mypkg/BUILD:

load(":myrules.bzl", "myrule")
load(":myrules_test.bzl", "myrules_test_suite")

# Production use of the rule.
myrule(
    name = "mytarget",
)

# Call a macro that defines targets that perform the tests at analysis time,
# and that can be executed with "bazel test" to return the result.
myrules_test_suite(name = "myrules_test")

bazel test //mypkg:myrules_test के साथ टेस्ट किया जा सकता है.

शुरुआती load() स्टेटमेंट के अलावा, फ़ाइल के दो मुख्य हिस्से होते हैं:

  • खुद जांच करता है, जिनमें से हर एक में 1) जांच के नियम के लिए विश्लेषण करने का समय लागू करना, 2) analysistest.make() के ज़रिए जांच करने का नियम का एलान करना और 3) लोड होने के समय का फ़ंक्शन शामिल है (मैक्रो) नियम-अंडर-टेस्ट (और उसकी निर्भरता) की घोषणा और परीक्षण नियम के लिए. अगर दावों को टेस्ट के उदाहरणों के बीच नहीं बदला जाता है, तो 1) और 2) को एक से ज़्यादा टेस्ट मामलों में शेयर किया जा सकता है.

  • टेस्ट सुइट फ़ंक्शन, हर टेस्ट के लिए लोड होने के समय के फ़ंक्शन को कॉल करता है और सभी टेस्ट को एक साथ इकट्ठा करके, test_suite टारगेट के बारे में बताता है.

एक जैसे नाम देने के लिए, सुझाए गए नाम वाले कन्वेंशन का पालन करें: foo को टेस्ट के उस नाम का हिस्सा बनाने दें जो यह बताता हो कि टेस्ट क्या जांच कर रहा है (ऊपर दिए गए उदाहरण में provider_contents). उदाहरण के लिए, JUnit की जांच करने के एक तरीके का नाम testFoo होगा.

इसके बाद:

  • टेस्ट जनरेट करने के लिए मैक्रो और टेस्ट के तहत टारगेट का नाम _test_foo होना चाहिए (_test_provider_contents)

  • इसके जांच के नियम का नाम foo_test (provider_contents_test) होना चाहिए

  • इस नियम के टारगेट का लेबल foo_test (provider_contents_test) होना चाहिए

  • जांच के नियम के लिए, लागू करने वाले फ़ंक्शन का नाम _foo_test_impl (_provider_contents_test_impl) होना चाहिए

  • टेस्ट के नियमों के टारगेट के लेबल और उनकी डिपेंडेंसी, foo_ (provider_contents_) से पहले जुड़ी होनी चाहिए

ध्यान दें कि सभी टारगेट के लेबल, एक ही बिल्ड पैकेज में दिए गए अन्य लेबल के साथ मेल नहीं खा सकते हैं, इसलिए टेस्ट के लिए एक खास नाम का इस्तेमाल करना मददगार होता है.

जांच में गड़बड़ी हुई

यह पुष्टि करने से उपयोगी हो सकता है कि कोई नियम कुछ खास इनपुट या किसी खास स्थिति में फ़ेल हो जाता है. विश्लेषण टेस्ट फ़्रेमवर्क का इस्तेमाल करके, ऐसा किया जा सकता है:

analysistest.make के साथ बनाए गए टेस्ट के नियम में expect_failure के बारे में बताया जाना चाहिए:

failure_testing_test = analysistest.make(
    _failure_testing_test_impl,
    expect_failure = True,
)

जांच के नियम को लागू करने के बाद, इस तरह के मैसेज का होना ज़रूरी है (खास तौर पर, फ़ेल होने के मैसेज):

def _failure_testing_test_impl(ctx):
    env = analysistest.begin(ctx)
    asserts.expect_failure(env, "This rule should never work")
    return analysistest.end(env)

यह भी पक्का करें कि टेस्ट के तहत आपका टारगेट खास तौर पर 'मैन्युअल' टैग किया गया है. इसके बिना, :all का इस्तेमाल करके अपने पैकेज में सभी टारगेट बनाने से, एक ऐसा टारगेट बन जाएगा जो जान-बूझकर नहीं होता है और उसे बनाने में कोई गड़बड़ी दिखेगी. 'मैन्युअल' के साथ, टेस्ट के तहत आपका टारगेट सिर्फ़ तब बनाया जाएगा, जब साफ़ तौर पर बताया गया हो या किसी गैर-मैन्युअल टारगेट (जैसे कि आपका टेस्ट नियम) की निर्भरता के तौर पर:

def _test_failure():
    myrule(name = "this_should_fail", tags = ["manual"])

    failure_testing_test(name = "failure_testing_test",
                         target_under_test = ":this_should_fail")

# Then call _test_failure() in the macro which generates the test suite and add
# ":failure_testing_test" to the suite's test targets.

रजिस्टर की गई कार्रवाइयों की पुष्टि की जा रही है

उदाहरण के लिए, आप ctx.actions.run() का इस्तेमाल करके ऐसी जांच लिख सकते हैं जो आपके नियम के रजिस्टर होने की कार्रवाई के बारे में दावा करती हों. आप अपने विश्लेषण टेस्ट नियम लागू करने वाले फ़ंक्शन में ऐसा कर सकते हैं. एक उदाहरण:

def _inspect_actions_test_impl(ctx):
    env = analysistest.begin(ctx)

    target_under_test = analysistest.target_under_test(env)
    actions = analysistest.target_actions(env)
    asserts.equals(env, 1, len(actions))
    action_output = actions[0].outputs.to_list()[0]
    asserts.equals(
        env, target_under_test.label.name + ".out", action_output.basename)
    return analysistest.end(env)

ध्यान दें कि analysistest.target_actions(env) उन Action ऑब्जेक्ट की सूची लौटाता है, जो टेस्ट के तहत टारगेट के ज़रिए रजिस्टर की गई कार्रवाइयां दिखाते हैं.

अलग-अलग फ़्लैग के तहत नियम व्यवहार की पुष्टि करना

हो सकता है कि आप यह पुष्टि करना चाहें कि आपका असली नियम कुछ बिल्ड फ़्लैग के साथ किसी खास तरीके से काम करता है या नहीं. उदाहरण के लिए, अगर कोई उपयोगकर्ता तय करता है, तो आपका नियम अलग तरह से काम कर सकता है:

bazel build //mypkg:real_target -c opt

बनाम

bazel build //mypkg:real_target -c dbg

पहली नज़र में, आप अपनी पसंद के मुताबिक बिल्ड फ़्लैग का इस्तेमाल करके, टेस्ट के तहत टारगेट की जांच कर सकते हैं:

bazel test //mypkg:myrules_test -c opt

लेकिन फिर आपके परीक्षण सुइट में एक साथ एक परीक्षण शामिल होना संभव नहीं होता है, जो -c opt के अंतर्गत नियम व्यवहार की पुष्टि करता है और दूसरा परीक्षण जो -c dbg के अंतर्गत नियम व्यवहार की पुष्टि करता है. दोनों टेस्ट एक ही बिल्ड में नहीं चलाए जा सकेंगे!

टेस्ट नियम तय करते समय पसंद के मुताबिक बिल्ड फ़्लैग तय करके इसे ठीक किया जा सकता है:

myrule_c_opt_test = analysistest.make(
    _myrule_c_opt_test_impl,
    config_settings = {
        "//command_line_option:compilation_mode": "opt",
    },
)

आम तौर पर, मौजूदा बिल्ड फ़्लैग के आधार पर जांच में आने वाले टारगेट का विश्लेषण किया जाता है. config_settings बताने से, तय किए गए कमांड लाइन विकल्पों के मान बदल जाते हैं. (कोई भी बिना विकल्प वाले विकल्प उनके मान को वास्तविक निर्देश पंक्ति से बनाए रखेंगे).

बताए गए config_settings डिक्शनरी में, कमांड लाइन फ़्लैग के आगे एक खास प्लेसहोल्डर मान //command_line_option: होना चाहिए, जैसा कि ऊपर दिखाया गया है.

आर्टफ़ैक्ट की पुष्टि की जा रही है

आपकी जनरेट की गई फ़ाइलें सही हैं या नहीं, यह पता लगाने के मुख्य तरीके ये हैं:

  • आप शेल, Python या दूसरी भाषा में टेस्ट स्क्रिप्ट लिख सकते हैं और सही *_test तरह के नियम बना सकते हैं.

  • आप जिस तरह का टेस्ट करना चाहते हैं उसके लिए खास नियम का इस्तेमाल कर सकते हैं.

टेस्ट टारगेट का इस्तेमाल करना

किसी सह-प्रॉडक्ट की पुष्टि करने का सबसे आसान तरीका है कि आप स्क्रिप्ट लिखें और अपनी बिल्ड फ़ाइल में *_test टारगेट जोड़ें. आप जिन खास कलाकृतियों की जांच करना चाहते हैं, वे इस टारगेट की डेटा डिपेंडेंसी होनी चाहिए. अगर आपके पुष्टि करने वाले तर्क में एक से ज़्यादा टेस्ट के लिए फिर से इस्तेमाल किया जा सकता है, तो यह एक ऐसी स्क्रिप्ट होनी चाहिए जो टेस्ट लाइन के args एट्रिब्यूट से नियंत्रित होने वाले कमांड लाइन तर्कों को लेती है. यहां एक उदाहरण दिया गया है जिससे यह पुष्टि होती है कि ऊपर दिए गए मान से myrule का आउटपुट "abc" है.

//mypkg/myrule_validator.sh:

if [ "$(cat $1)" = "abc" ]; then
  echo "Passed"
  exit 0
else
  echo "Failed"
  exit 1
fi

//mypkg/BUILD:

...

myrule(
    name = "mytarget",
)

...

# Needed for each target whose artifacts are to be checked.
sh_test(
    name = "validate_mytarget",
    srcs = [":myrule_validator.sh"],
    args = ["$(location :mytarget.out)"],
    data = [":mytarget.out"],
)

कस्टम नियम का उपयोग करना

इससे ज़्यादा मुश्किल विकल्प एक शेल स्क्रिप्ट को ऐसे टेंप्लेट के रूप में लिखना है, जिसे नए नियम से तुरंत शुरू किया जा सके. इसमें और भी सीधे तौर पर जानकारी नहीं दी जाती है और Starlark का तर्क भी शामिल होता है, लेकिन इससे Build की फ़ाइलें साफ़ हो जाती हैं. इसका फ़ायदा यह है कि स्क्रिप्ट के बजाय, Starlark में किसी भी तर्क को पहले से प्रोसेस किया जा सकता है. स्क्रिप्ट में, थोड़ा ज़्यादा अपने-आप दस्तावेज़ लिखने की सुविधा है. इसकी वजह यह है कि इसमें संख्या वाले प्लेसहोल्डर के बजाय, सांकेतिक प्लेसहोल्डर का इस्तेमाल होता है ( तर्कों के लिए).

//mypkg/myrule_validator.sh.template:

if [ "$(cat %TARGET%)" = "abc" ]; then
  echo "Passed"
  exit 0
else
  echo "Failed"
  exit 1
fi

//mypkg/myrule_validation.bzl:

def _myrule_validation_test_impl(ctx):
  """Rule for instantiating myrule_validator.sh.template for a given target."""
  exe = ctx.outputs.executable
  target = ctx.file.target
  ctx.actions.expand_template(output = exe,
                              template = ctx.file._script,
                              is_executable = True,
                              substitutions = {
                                "%TARGET%": target.short_path,
                              })
  # This is needed to make sure the output file of myrule is visible to the
  # resulting instantiated script.
  return [DefaultInfo(runfiles=ctx.runfiles(files=[target]))]

myrule_validation_test = rule(
    implementation = _myrule_validation_test_impl,
    attrs = {"target": attr.label(allow_single_file=True),
             # You need an implicit dependency in order to access the template.
             # A target could potentially override this attribute to modify
             # the test logic.
             "_script": attr.label(allow_single_file=True,
                                   default=Label("//mypkg:myrule_validator"))},
    test = True,
)

//mypkg/BUILD:

...

myrule(
    name = "mytarget",
)

...

# Needed just once, to expose the template. Could have also used export_files(),
# and made the _script attribute set allow_files=True.
filegroup(
    name = "myrule_validator",
    srcs = [":myrule_validator.sh.template"],
)

# Needed for each target whose artifacts are to be checked. Notice that you no
# longer have to specify the output file name in a data attribute, or its
# $(location) expansion in an args attribute, or the label for the script
# (unless you want to override it).
myrule_validation_test(
    name = "validate_mytarget",
    target = ":mytarget",
)

इसके अलावा, आप टेंप्लेट एक्सपैंशन कार्रवाई का इस्तेमाल करने के बजाय, स्ट्रिंग को .bzl फ़ाइल में इनलाइन कर सकते हैं. साथ ही, str.format तरीके या % का इस्तेमाल करके, विश्लेषण के चरण में इसे बड़ा कर सकते हैं- फ़ॉर्मैटिंग.

Starlark की सुविधाएं इस्तेमाल करना

Skylib के unittest.bzl फ़्रेमवर्क का इस्तेमाल उपयोगिता फ़ंक्शन की जांच करने के लिए किया जा सकता है (यानी कि वे फ़ंक्शन जो न तो मैक्रो हों और न ही नियम लागू करते हैं ). unittest.bzl की analysistest लाइब्रेरी का इस्तेमाल करने के बजाय, unittest का इस्तेमाल किया जा सकता है. ऐसे परीक्षण सुइट के लिए, सुविधा फ़ंक्शन unittest.suite() का इस्तेमाल बॉयलरप्लेट को कम करने के लिए किया जा सकता है.

//mypkg/myhelpers.bzl:

def myhelper():
    return "abc"

//mypkg/myhelpers_test.bzl:

load("@bazel_skylib//lib:unittest.bzl", "asserts", "unittest")
load(":myhelpers.bzl", "myhelper")

def _myhelper_test_impl(ctx):
  env = unittest.begin(ctx)
  asserts.equals(env, "abc", myhelper())
  return unittest.end(env)

myhelper_test = unittest.make(_myhelper_test_impl)

# No need for a test_myhelper() setup function.

def myhelpers_test_suite(name):
  # unittest.suite() takes care of instantiating the testing rules and creating
  # a test_suite.
  unittest.suite(
    name,
    myhelper_test,
    # ...
  )

//mypkg/BUILD:

load(":myhelpers_test.bzl", "myhelpers_test_suite")

myhelpers_test_suite(name = "myhelpers_tests")

ज़्यादा उदाहरणों के लिए, Skylib की अपनी जांच देखें.