Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade redis #31279

Merged
merged 5 commits into from
May 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions airflow/providers/redis/provider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,7 @@ versions:

dependencies:
- apache-airflow>=2.4.0
# Redis 4 introduced a number of changes that likely need testing including mixins in redis commands
# as well as unquoting URLS with `urllib.parse.unquote`:
# https://github.com/redis/redis-py/blob/master/CHANGES
# TODO: upgrade to support redis package >=4
- redis~=3.2
eladkal marked this conversation as resolved.
Show resolved Hide resolved
- redis>=3.2.0

integrations:
- integration-name: Redis
Expand Down
9 changes: 8 additions & 1 deletion docs/apache-airflow-providers-redis/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,16 @@ Content
:maxdepth: 1
:caption: Resources

Example DAGs <https://github.com/apache/airflow/tree/providers-redis/|version|/tests/system/providers/redis>
PyPI Repository <https://pypi.org/project/apache-airflow-providers-redis/>
Installing from sources <installing-providers-from-sources>

.. toctree::
:hidden:
:caption: System tests

System Tests <_api/tests/system/providers/redis/index>

.. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN AT RELEASE TIME!


Expand Down Expand Up @@ -73,7 +80,7 @@ Requirements
PIP package Version required
================== ==================
``apache-airflow`` ``>=2.3.0``
``redis`` ``~=3.2``
``redis`` ``>=3.2.0``
================== ==================

.. include:: ../../airflow/providers/redis/CHANGELOG.rst
2 changes: 1 addition & 1 deletion generated/provider_dependencies.json
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@
"redis": {
"deps": [
"apache-airflow>=2.4.0",
"redis~=3.2"
"redis>=3.2.0"
],
"cross-providers-deps": []
},
Expand Down
16 changes: 16 additions & 0 deletions tests/system/providers/redis/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
95 changes: 95 additions & 0 deletions tests/system/providers/redis/example_redis_publish.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
#
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is cool! Thanks for being receptive :)

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""
This is an example DAG which uses RedisPublishOperator, RedisPubSubSensor and RedisKeySensor.
In this example, we create 3 tasks which execute sequentially.
The first task is to publish a particular message to redis using the RedisPublishOperator.
The second task is to wait for a particular message at a particular channel to arrive in redis
using the RedisPubSubSensor, and the third task is to wait for a particular key to arrive in
redis using the RedisKeySensor.

"""
from __future__ import annotations

import os
from datetime import datetime

# [START import_module]
from airflow import DAG
from airflow.providers.redis.operators.redis_publish import RedisPublishOperator
from airflow.providers.redis.sensors.redis_key import RedisKeySensor
from airflow.providers.redis.sensors.redis_pub_sub import RedisPubSubSensor

# [END import_module]
# [START instantiate_dag]
ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")

default_args = {
"start_date": datetime(2023, 5, 15),
"max_active_runs": 1,
}

with DAG(
dag_id="redis_example",
default_args=default_args,
) as dag:
# [START RedisPublishOperator_DAG]
publish_task = RedisPublishOperator(
task_id="publish_task",
redis_conn_id="redis_default",
channel="your_channel",
message="Start processing",
dag=dag,
)

# [END RedisPublishOperator_DAG]

# [START RedisPubSubSensor_DAG]
pubsub_sensor_task = RedisPubSubSensor(
task_id="pubsub_sensor_task",
redis_conn_id="redis_default",
channels="your_channel",
dag=dag,
timeout=600,
poke_interval=30,
)
# [END RedisPubSubSensor_DAG]

# [START RedisKeySensor_DAG]
key_sensor_task = RedisKeySensor(
task_id="key_sensor_task",
redis_conn_id="redis_default",
key="your_key",
dag=dag,
timeout=600,
poke_interval=30,
)
# [END RedisKeySensor_DAG]

publish_task >> pubsub_sensor_task >> key_sensor_task

from tests.system.utils.watcher import watcher

# This test needs watcher in order to properly mark success/failure
# when "tearDown" task with trigger rule is part of the DAG
list(dag.tasks) >> watcher()

from tests.system.utils import get_test_run # noqa: E402

# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
test_run = get_test_run(dag)