Skip to main content
Ctrl+K

3-ID-C BITS 0.0.1

  • Tutorials
  • How-to guides
  • Reference
  • Explanation
  • Contributing
  • API Reference
  • GitHub
  • Issue tracker
  • Tutorials
  • How-to guides
  • Reference
  • Explanation
  • Contributing
  • API Reference
  • GitHub
  • Issue tracker

Section Navigation

  • Cheat sheet
  • Quick reference
  • Configuration files
  • Presentations
  • API Reference
    • id3c
      • id3c.callbacks
        • id3c.callbacks.demo_nexus_callback
        • id3c.callbacks.demo_spec_callback
      • id3c.configs
      • id3c.devices
        • id3c.devices.area_detector
        • id3c.devices.interlocked_motor
        • id3c.devices.laser_optics
        • id3c.devices.omega_laser_interlock
      • id3c.plans
        • id3c.plans.ad_plugins
        • id3c.plans.flyscan_3idc
        • id3c.plans.sim_plans
      • id3c.startup
      • id3c.suspenders
      • id3c.tests
        • id3c.tests.test_ad_plugins
        • id3c.tests.test_check_ad_files_symlink
        • id3c.tests.test_check_cam_armed
        • id3c.tests.test_effective_num_images
        • id3c.tests.test_ensure_ad_files_symlink
        • id3c.tests.test_expected_frame_count
        • id3c.tests.test_external_link_target
        • id3c.tests.test_flyscan_3idc_analysis
        • id3c.tests.test_flyscan_repair
        • id3c.tests.test_pair_frames_from_ad_file
        • id3c.tests.test_path_templates
        • id3c.tests.test_wait_for_openable
        • id3c.tests.test_write_flyscan_data
      • id3c.user
        • id3c.user.s3idc_plans
      • id3c.utils
        • id3c.utils.flyscan_3idc_analysis
        • id3c.utils.flyscan_repair
  • Reference
  • API Reference
  • id3c
  • id3c.tests
  • id3c.tests.test_check_ad_files_symlink

id3c.tests.test_check_ad_files_symlink#

Tests for id3c.plans.flyscan_3idc._check_ad_files_symlink.

Verifies: - existing image-files symlink (symlink OR plain dir) is silently

accepted;

  • a missing symlink emits a WARNING containing the suggested ln -s command and the verification steps;

  • the warning fires once per (master_dir, target) combination;

  • a custom read_path_template is reflected in the suggested target;

  • when read_path_template is missing the helper uses a placeholder the operator must fill in;

  • the helper never creates or modifies the link.

Functions#

test_existing_ad_files_symlink_is_accepted_silently(...)

A pre-existing ad_files symlink (any target) means no warning.

test_existing_ad_files_directory_is_accepted_silently(...)

A plain directory named {det.name}_files (no symlink) is accepted.

test_missing_ad_files_emits_warning_with_ln_s_command(...)

Missing ad_files emits a WARNING with the ln -s recipe.

test_warning_fires_only_once_per_master_dir_target_combination(...)

Second call with the same (master_dir, target) is silent.

test_warning_fires_again_when_master_dir_changes(...)

A different master_dir legitimately warns again.

test_missing_read_path_template_uses_placeholder(...)

Missing read_path_template yields a placeholder target.

test_helper_never_creates_the_symlink(tmp_path)

Pure paranoia: the helper must never create the link.

Module Contents#

id3c.tests.test_check_ad_files_symlink.test_existing_ad_files_symlink_is_accepted_silently(tmp_path, caplog)[source]#

A pre-existing ad_files symlink (any target) means no warning.

id3c.tests.test_check_ad_files_symlink.test_existing_ad_files_directory_is_accepted_silently(tmp_path, caplog)[source]#

A plain directory named {det.name}_files (no symlink) is accepted.

id3c.tests.test_check_ad_files_symlink.test_missing_ad_files_emits_warning_with_ln_s_command(tmp_path, caplog)[source]#

Missing ad_files emits a WARNING with the ln -s recipe.

Verifies the warning includes the suggested command, the verification step, and the audience-appropriate explanation.

id3c.tests.test_check_ad_files_symlink.test_warning_fires_only_once_per_master_dir_target_combination(tmp_path, caplog)[source]#

Second call with the same (master_dir, target) is silent.

id3c.tests.test_check_ad_files_symlink.test_warning_fires_again_when_master_dir_changes(tmp_path, caplog)[source]#

A different master_dir legitimately warns again.

id3c.tests.test_check_ad_files_symlink.test_missing_read_path_template_uses_placeholder(tmp_path, caplog)[source]#

Missing read_path_template yields a placeholder target.

The operator must fill it in; we explicitly do NOT guess /.

id3c.tests.test_check_ad_files_symlink.test_helper_never_creates_the_symlink(tmp_path)[source]#

Pure paranoia: the helper must never create the link.

previous

id3c.tests.test_ad_plugins

next

id3c.tests.test_check_cam_armed

On this page
  • Functions
  • Module Contents
    • test_existing_ad_files_symlink_is_accepted_silently()
    • test_existing_ad_files_directory_is_accepted_silently()
    • test_missing_ad_files_emits_warning_with_ln_s_command()
    • test_warning_fires_only_once_per_master_dir_target_combination()
    • test_warning_fires_again_when_master_dir_changes()
    • test_missing_read_path_template_uses_placeholder()
    • test_helper_never_creates_the_symlink()
Edit on GitHub
Show Source

© Copyright 2014-2026, APS.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.20.0.